Rosette plugin

• Host: analytics.babelstreet.com/rest/v1. The old api.rosette.com still answers, but the current docs and the official bindings point here, so this plugin uses the new host.
• Header: X-BabelStreetAPI-Key. The legacy X-RosetteAPI-Key is still accepted by the server, but the bindings send the new one and so does the plugin.

• Give content or contentUri, never both. contentUri fetches the page server-side over http, https, ftp or ftps. The plugin rejects a request with neither, since there is nothing to analyse, and one with both, since Rosette treats them as alternatives.
• language and profileId are optional. Setting language skips detection and is worth doing when you know it, because detection errors change the result of every downstream analysis. A profileId applies a saved profile.
• A retry costs one more API call. With content it returns the same answer. With contentUri Rosette fetches the page again, so a page that changed in between gives a different answer.

• language returns only languageDetections, most likely first. There is no separate top-level answer: the first candidate is the result.
• entities groups mentions by entityId, so an entity’s count is how many times it appears, and mentionOffsets holds the start and end of each one. A Q… ID is a Wikidata item; a T… ID is local to the text.
• sentiment gives the document a label (pos, neg or neu) and a confidence; each entity carries its own label and confidence under sentiment.
• tokens returns the tokens only. For part-of-speech tags and lemmas, call morphology, which returns tokens, posTags and lemmas as arrays in the same order, plus compoundComponents and hanReadings with null for a token that has none.
• sentences returns each sentence as text, with its trailing whitespace.
• topics returns keyphrases (phrases from the text) and concepts (broader themes with a Wikidata conceptId), each with a salience rather than a probability, so the scores are not comparable across documents the way a probability would be.
• relationships links arg1 and arg2 (sometimes arg3) through a predicate, such as PER-EMPLOYEE-MEMBER-OF.
• semantics.similarTerms needs resultLanguages (for example ["eng"]); the API refuses the call without it. The answer is keyed by language.
• semantics.vector returns documentEmbedding, one vector for the whole text.
• nameSimilarity is not symmetric. It scores how likely name1 is to be the same entity as name2, so swapping them can change the score. Use language, script and entityType on each name to sharpen it.
• transliteration is not translation. It moves text between Latin and the native script of its language and keeps the words; it takes no target script. nameTranslation is the one that translates a name into another language.

• 16 typed API operations

​

Setup

npm install corsair @corsair-dev/rosette better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/rosette better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/rosette better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/rosette better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { rosette } from '@corsair-dev/rosette';

export const corsair = createCorsair({
	plugins: [
		rosette(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

rosette()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'rosette',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.rosette.api.sentiment({ content: 'I love this product, but the delivery was slow.' });

​

What’s next