Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejavascript
titleScoring parameters - "numAnalyze"
{
	"score": {
		"numAnalyze": integer, // (default: 1000)
		"scoreEnts": boolean, // (default: true) 
		// See following sections for other parameters
	}
}

...

Note that this parameter is also currently used to determine how many documents are used to generate the "event timeline".

If "scoreEnts" is set to false (defaults to true if not present), then entities do not have significance scores generated.

  • This can be useful in cases where documents are not being scored using significance either (see "sigWeight" field below) - in this case rather than retrieving "numAnalyse" documents, only "output.docs.numReturn" can be retrieved, which is much faster.
Code Block
languagejavascript
titleScoring parameters - significance/relevance weighting
{
	"score": {
		// See preceding sections for other parameters
		"sigWeight": number, // (default: 0.67)
		"relWeight": number, // (default: 0.33)
		"adjustAggregateSig": boolean (default: auto-decide, see below)
		// See following sections for other parameters
	}
}

...

Info

If both weights are set to 0 then documents are ranked in descending date order and no scoring is performed.

TODO

Code Block
languagejavascript
titleScoring parameters - time proximity
{
	"score": {
		// See preceding sections for other parameters
		"timeProx":{
			"time": string,
			"decay": string
		},
		// See following sections for other parameters
	}
}

...

Code Block
languagejavascript
titleExample "score" object
{
	"score":{
		"numAnalyze": 1000,
		"sigWeight": 0.67,
		"relWeight": 0.33,
		"
		"timeProx": {
			"time": "now",
			"duration": "1m"
		}
	}
}