Document Collections

Manage your custom document collections in a Vector Dababase.

Get all collections

get

Retrieve all stored document collections

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Query parameters

limitintegerOptional

The maximum number of collections to return - defaults to 100

Default: 100

offsetintegerOptional

The offset to start from - defaults to 0

Default: 0

Responses

200

Successful operation

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/collections

GET /collections HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "63a7d335-209c-5a1e-a8b2-686772fe2e55",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "items": [
    {
      "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
      "type": "collection",
      "href": "<RESOURCE-URL>",
      "properties": {
        "name": "My first collection",
        "description": "My first collection description",
        "chunking": {
          "enabled": true,
          "strategy": {
            "name": "fixed_size",
            "config": {
              "chunk_overlap": 50,
              "chunk_size": 128
            }
          }
        },
        "embedding": {
          "model": "BAAI/bge-large-en-v1.5"
        },
        "engine": {
          "db_type": "pgvector"
        },
        "labels": {
          "label_1": "label value",
          "label_2": "label value"
        }
      }
    },
    {
      "id": "bbdda335-209c-5a1e-a8b2-686772fe7a33",
      "type": "collection",
      "href": "<RESOURCE-URL>",
      "properties": {
        "name": "My second collection",
        "description": "My second collection description",
        "chunking": {
          "enabled": false
        },
        "embedding": {
          "model": "sentence-transformers/paraphrase-multilingual-mpnet-base-v2"
        },
        "engine": {
          "db_type": "chromadb"
        },
        "labels": {
          "label_1": "label value",
          "label_2": "label value"
        }
      }
    }
  ]
}

Create a new collection

post

Create a new, empty document collection for storing documents

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Body

idstringRead-onlyOptional

The unique identifier of the documents collection.

hrefstringRead-onlyOptional

Resource URL

typestring · enumRead-onlyOptional

Type of object

Possible values:

Responses

201

Successful operation.

application/json

idstringRead-onlyOptional

The unique identifier of the documents collection.

Example: 4b71d0fe-d992-463e-82a1-de337d88ac2d

hrefstringRead-onlyOptional

Resource URL

typestring · enumRead-onlyOptional

Type of object

Example: collectionPossible values:

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

post

/collections

POST /collections HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "type": "collection",
  "properties": {
    "name": "My collection",
    "description": "My collection description",
    "chunking": {
      "enabled": true,
      "strategy": {
        "name": "fixed_size",
        "config": {
          "chunk_overlap": 50,
          "chunk_size": 128
        }
      }
    },
    "embedding": {
      "model": "BAAI/bge-large-en-v1.5"
    },
    "engine": {
      "db_type": "pgvector"
    },
    "labels": {
      "label_1": "label value",
      "label_2": "label value"
    }
  }
}

{
  "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "properties": {
    "name": "My collection",
    "description": "My collection description",
    "chunking": {
      "enabled": true,
      "strategy": {
        "name": "fixed_size",
        "config": {
          "chunk_overlap": 50,
          "chunk_size": 128
        }
      }
    },
    "embedding": {
      "model": "BAAI/bge-large-en-v1.5"
    },
    "engine": {
      "db_type": "pgvector"
    },
    "labels": {
      "label_1": "label value",
      "label_2": "label value"
    }
  }
}

Get collection

get

Returns the properties and metadata for the document collection

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Responses

200

Successful operation.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/collections/{collectionId}

GET /collections/{collectionId} HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "properties": {
    "name": "My collection",
    "description": "My collection description",
    "chunking": {
      "enabled": true,
      "strategy": {
        "name": "fixed_size",
        "config": {
          "chunk_overlap": 50,
          "chunk_size": 128
        }
      }
    },
    "embedding": {
      "model": "BAAI/bge-large-en-v1.5"
    },
    "engine": {
      "db_type": "pgvector"
    },
    "labels": {
      "label_1": "label value",
      "label_2": "label value"
    }
  }
}

Update an existing collection

put

Update collection details and metadata. No modification is done on the documents.

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Body

idstringRead-onlyOptional

The unique identifier of the documents collection.

Example: 4b71d0fe-d992-463e-82a1-de337d88ac2d

hrefstringRead-onlyOptional

Resource URL

typestring · enumRead-onlyOptional

Type of object

Example: collectionPossible values:

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

put

/collections/{collectionId}

PUT /collections/{collectionId} HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "properties": {
    "name": "My updated collection",
    "description": "My updated collection description",
    "labels": {
      "label_1": "updated label value"
    }
  }
}

{
  "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "properties": {
    "name": "My updated collection",
    "description": "My updated collection description",
    "chunking": {
      "enabled": true,
      "strategy": {
        "name": "fixed_size",
        "config": {
          "chunk_overlap": 50,
          "chunk_size": 128
        }
      }
    },
    "embedding": {
      "model": "BAAI/bge-large-en-v1.5"
    },
    "engine": {
      "db_type": "pgvector"
    },
    "labels": {
      "label_1": "updated label value",
      "label_2": "label value"
    }
  }
}

Delete a collection and its documents

delete

Delete a collection and all documents stored in it

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Responses

204

Successful operation.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

delete

/collections/{collectionId}

DELETE /collections/{collectionId} HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get the list of documents stored in the collection

get

Get the list of documents stored in the collection

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Query parameters

limitintegerOptional

The maximum number of documents to return - defaults to 100

Default: 100

offsetintegerOptional

The offset to start from - defaults to 0

Default: 0

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/collections/{collectionId}/documents

GET /collections/{collectionId}/documents HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "63a7d335-209c-5a1e-a8b2-686772fe2e55",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "items": [
    {
      "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
      "type": "document",
      "properties": {
        "contentType": "text/plain",
        "name": "Lorem doc 1",
        "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>"
      },
      "metadata": {
        "lastModifiedDate": "2022-07-19T15:52:53Z",
        "createdDate": "2022-07-19T15:52:53Z"
      }
    },
    {
      "id": "7ea7d335-209c-5a1e-a8b2-686772fe7a22",
      "type": "document",
      "properties": {
        "contentType": "text/plain",
        "name": "Lorem doc 2",
        "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>"
      },
      "metadata": {
        "lastModifiedDate": "2022-08-21T15:52:53Z",
        "createdDate": "2022-08-21T15:52:53Z"
      }
    }
  ]
}

Add documents to the collection

put

Add documents to the collection.

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Body

idstringRead-onlyOptional

Unique Collection Identifier

Example: d4a7d335-209c-5a1e-a8b2-686772fe7a55

typestring · enumRead-onlyRequired

Entity type

Possible values:

hrefstringRead-onlyOptional

Resource URL

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

put

/collections/{collectionId}/documents

PUT /collections/{collectionId}/documents HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "type": "collection",
  "items": [
    {
      "type": "document",
      "properties": {
        "name": "Lorem Doc 1",
        "description": "This is a document about lorem ipsum",
        "contentType": "text/plain",
        "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>",
        "labels": {
          "topic": "linux",
          "subtopic": "networking"
        }
      }
    }
  ]
}

{
  "id": "collection_id",
  "type": "collection",
  "href": "collection_href",
  "items": [
    {
      "type": "document",
      "properties": {
        "name": "Lorem Doc 1",
        "description": "This is a document about lorem ipsum",
        "contentType": "text/plain",
        "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>",
        "labels": {
          "topic": "linux",
          "subtopic": "networking"
        }
      }
    }
  ]
}

Prune all documents in a collection

delete

Delete all documents from a collection, thus pruning it

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Responses

200

Successful operation.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

delete

/collections/{collectionId}/documents

DELETE /collections/{collectionId}/documents HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get document details

get

Retreieve document's details.

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

documentIdstringRequired

The ID of the document.

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/collections/{collectionId}/documents/{documentId}

GET /collections/{collectionId}/documents/{documentId} HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
  "type": "document",
  "href": "<RESOURCE-URL>",
  "properties": {
    "contentType": "text/plain",
    "name": "Lorem doc 1",
    "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>",
    "description": "This is a document about lorem ipsum"
  },
  "metadata": {
    "lastModifiedDate": "2022-07-19T15:52:53Z",
    "createdDate": "2022-07-19T15:52:53Z"
  }
}

Update a document

put

Replaces the existing document identified by documentId with the contents of the request payload

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

documentIdstringRequired

The ID of the document.

Body

idstringRead-onlyOptional

The unique identifier of the document.

Example: 4b71d0fe-d992-463e-82a1-de337d88ac2d

typestring · enumRead-onlyOptional

Type of object

Possible values:

hrefstringRead-onlyOptional

Resource URL

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

put

/collections/{collectionId}/documents/{documentId}

PUT /collections/{collectionId}/documents/{documentId} HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "type": "document",
  "properties": {
    "name": "Lorem Doc 1",
    "description": "This is a document about lorem ipsum",
    "contentType": "text/plain",
    "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>",
    "labels": {
      "topic": "linux",
      "subtopic": "networking"
    }
  }
}

{
  "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
  "type": "document",
  "href": "<RESOURCE-URL>",
  "properties": {
    "contentType": "text/plain",
    "name": "Lorem doc 1",
    "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>",
    "description": "This is a document about lorem ipsum"
  },
  "metadata": {
    "lastModifiedDate": "2022-07-19T15:52:53Z",
    "createdDate": "2022-07-19T15:52:53Z"
  }
}

Delete a document

delete

Remove a document from the collection

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

documentIdstringRequired

The ID of the document.

Responses

200

Successful operation.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

delete

/collections/{collectionId}/documents/{documentId}

DELETE /collections/{collectionId}/documents/{documentId} HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get document chunks details

get

Retrieve existing chunks for the document with documentId.

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

documentIdstringRequired

The ID of the document.

Query parameters

limitinteger · min: 1 · max: 10000Optional

The maximum number of documents to return - defaults to 100

Default: 100

offsetinteger · max: 1000000Optional

The offset to start from - defaults to 0

Default: 0

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

get

/collections/{collectionId}/documents/{documentId}/chunks

GET /collections/{collectionId}/documents/{documentId}/chunks HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "63a7d335-209c-5a1e-a8b2-686772fe2e55",
  "type": "collection",
  "href": "<RESOURCE-URL>",
  "items": [
    {
      "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
      "type": "document",
      "properties": {
        "contentType": "text/plain",
        "name": "Lorem doc 1",
        "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>"
      },
      "metadata": {
        "lastModifiedDate": "2022-07-19T15:52:53Z",
        "createdDate": "2022-07-19T15:52:53Z"
      }
    },
    {
      "id": "7ea7d335-209c-5a1e-a8b2-686772fe7a22",
      "type": "document",
      "properties": {
        "contentType": "text/plain",
        "name": "Lorem doc 2",
        "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>"
      },
      "metadata": {
        "lastModifiedDate": "2022-08-21T15:52:53Z",
        "createdDate": "2022-08-21T15:52:53Z"
      }
    }
  ]
}

Query a collection / search for related content

post

Query a collection / search for related content. This endpoint is used to return relevant documents from a collection.

Authorizations

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

collectionIdstringRequired

The ID of the collection.

Query parameters

Body

querystring · min: 1Required

The string used to query the vector database.

limitintegerOptional

The maximum number of matches to return.

Default: 10

Responses

200

Successful operation.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Forbidden

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

post

/collections/{collectionId}/query

POST /collections/{collectionId}/query HTTP/1.1
Host: inference.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "limit": 5,
  "query": "What is Managed Kubernetes?"
}

{
  "type": "result",
  "metadata": {
    "lastModifiedDate": "2022-08-21T15:52:53Z",
    "createdDate": "2022-08-21T15:52:53Z",
    "duration": 0.01
  },
  "properties": {
    "matches": [
      {
        "document": {
          "id": "9fa7d335-209c-5a1e-a8b2-686772fe7a33",
          "type": "document",
          "href": "<RESOURCE-URL>",
          "properties": {
            "contentType": "text/plain",
            "name": "Lorem doc 1",
            "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>"
          },
          "metadata": {
            "lastModifiedDate": "2022-07-19T15:52:53Z",
            "createdDate": "2022-07-19T15:52:53Z"
          }
        },
        "score": 0.99
      },
      {
        "document": {
          "id": "7ea7d335-209c-5a1e-a8b2-686772fe7a22",
          "type": "document",
          "href": "<RESOURCE-URL>",
          "properties": {
            "contentType": "text/plain",
            "name": "Lorem doc 2",
            "content": "<DOCUMENT-CONTENT-BASE64-ENCODED>"
          }
        }
      }
    ]
  }
}

PreviousFoundation Models NextModels

Last updated 1 month ago

Was this helpful?

Good morning

hashtagGet all collections

Unauthorized

Forbidden

Internal Server Error

hashtagCreate a new collection

Bad Request

Unauthorized

Forbidden

Internal Server Error

hashtagGet collection

Not Found

Internal Server Error

hashtagUpdate an existing collection

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagDelete a collection and its documents

Bad Request

Unauthorized

Not Found

Internal Server Error

hashtagGet the list of documents stored in the collection

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagAdd documents to the collection

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagPrune all documents in a collection

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagGet document details

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagUpdate a document

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagDelete a document

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagGet document chunks details

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

hashtagQuery a collection / search for related content

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error

Get all collections

Create a new collection

Get collection

Update an existing collection

Delete a collection and its documents

Get the list of documents stored in the collection

Add documents to the collection

Prune all documents in a collection

Get document details

Update a document

Delete a document

Get document chunks details

Query a collection / search for related content