addEntityDetails — Add named-entity tags to tokenized documents.

addEntityDetails(documents) adds named-entity metadata to a RunMat tokenizedDocument compatibility object. Use tokenDetails to view the resulting Entity column.

Syntax

updatedDocuments = addEntityDetails(documents)
updatedDocuments = addEntityDetails(documents,Name,Value)

Inputs

Returns

Errors

How addEntityDetails works

• documents must be a RunMat tokenizedDocument object.
• addEntityDetails(documents, Name, Value) supports RetokenizeMethod, DiscardKnownValues, and Model name-value pairs.
• RetokenizeMethod defaults to "entity", which merges simple adjacent entity tokens such as multiword locations. Use "none" to keep existing tokens.
• DiscardKnownValues defaults to false, so existing known entity details are preserved while missing or empty entries are filled.
• DiscardKnownValues, true recomputes every stored tag and ignores malformed stored entity details.
• Model, "auto" selects RunMat's built-in deterministic compatibility tagger. Custom hmmEntityModel inputs remain tracked as broader Text Analytics model infrastructure.
• addEntityDetails ensures sentence and part-of-speech details exist first, then updates part-of-speech details for recognized entities to "proper-noun".
• RunMat tags English and German tokens with deterministic compatibility rules for person, location, organization, other, and non-entity.
• If an existing tokenizedDocument object already carries Japanese or Korean language metadata, RunMat accepts the language and uses conservative token-class-aware fallback tags. Public Japanese/Korean tokenizedDocument construction and MeCab-backed entity models remain tracked.
• Exact MathWorks statistical entity-model parity remains tracked as broader Text Analytics work.

GPU memory and residency

addEntityDetails updates host tokenizedDocument metadata and has no provider kernel.

Examples

Add Entity Details

documents = tokenizedDocument("Mary uses MATLAB at MathWorks.");
documents = addEntityDetails(documents);
tdetails = tokenDetails(documents)

Expected output:

`tdetails.Entity` contains tags such as `"person"`, `"organization"`, `"other"`, and `"non-entity"`.

Keep Existing Tokens

documents = addEntityDetails(documents, "RetokenizeMethod", "none")

Expected output:

`documents` receives entity details without the entity retokenization pass.

Recompute Entity Details

documents = addEntityDetails(documents, "DiscardKnownValues", true)

Expected output:

`documents` has refreshed entity details.

Using addEntityDetails with coding agents

Open a RunMat example with live inputs, then ask the agent to explain how addEntityDetails changes the result.

FAQ

Related Strings functions

Open-source implementation

Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how addEntityDetails is executed, line by line, in Rust.

• View the source for addEntityDetails in Rust on GitHub
• Learn how the RunMat runtime works
• Found a bug? Open an issue with a minimal reproduction.

About RunMat

RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.

• RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
• Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.

Getting started · Benchmarks · Pricing