Delete documents - Charcoal

POST

namespaces

{namespace}

documents

delete

JavaScript

import Charcoal from '@charcoalhq/sdk';

const client = new Charcoal({
  apiKey: process.env['CHARCOAL_API_KEY'], // This is the default and can be omitted
});

const deleteDocumentsResponse = await client.namespaces.documents.delete('namespace', {
  document_ids: ['string'],
});

console.log(deleteDocumentsResponse.documents_deleted);

{
  "documents_deleted": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

namespace

string

required

Namespace identifier. Alphanumeric characters, hyphens, underscores, and dots. Max 128 characters.

Maximum string length: 128

Pattern: ^[A-Za-z0-9-_.]{1,128}$

Body

application/json

document_ids

string[]

required

Maximum array length: 10000

Response

Successful response

documents_deleted

integer

required

SearchSearches the documents in a namespace. Set `multiturn: true` to enable multi-turn mode, which returns a `session_id` and may return `clarification_needed` status when the system needs more information. Set `stream: true` to receive results as server-sent events; see `SearchStreamEvent` for the event shape. The stream closes after either a `session_result` or `error` event.

JavaScript

import Charcoal from '@charcoalhq/sdk';

const client = new Charcoal({
  apiKey: process.env['CHARCOAL_API_KEY'], // This is the default and can be omitted
});

const deleteDocumentsResponse = await client.namespaces.documents.delete('namespace', {
  document_ids: ['string'],
});

console.log(deleteDocumentsResponse.documents_deleted);

{
  "documents_deleted": 123
}