Get collector/dedup settings

GET

/api/v1/config/collector

const url = 'http://localhost:11044/api/v1/config/collector';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/config/collector \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns the effective memory-dedup collector settings for this world: enabled, dryRun, matcher, similarityThreshold and cron are resolved against the deployment defaults (never null); the five multi-signal weights are returned as stored (null means the matcher’s own default applies).

Authorizations

apiKeyAuth
basicAuth

Responses

200

Effective collector settings

*/*

The memory-dedup collector settings in force for this world. The first five are resolved against the deployment defaults and are never null; the five weights are returned as stored, where null means the matcher’s own default applies.

object

cron

required

When the sweep runs, as a Spring six-field cron expression

string

dryRun

required

Whether the sweep reports what it would merge instead of merging it

boolean

enabled

required

Whether the dedup sweep runs at all

boolean

entityOverlap

Weight of shared entities. Null means the matcher’s own default

number format: double

groundingOverlap

Weight of shared grounding. Null means the matcher’s own default

number format: double

lexical

Weight of lexical overlap. Null means the matcher’s own default

number format: double

matcher

required

Which matcher decides that two memories are the same

string

Example

multi-signal

provenanceOverlap

Weight of shared provenance. Null means the matcher’s own default

number format: double

similarityThreshold

required

How similar two memories must be to merge, in [0, 1]

number format: double

vector

Weight of vector similarity. Null means the matcher’s own default

number format: double