Class: TextAnnotationConfiguration

configuration for search

classDiagram class TextAnnotationConfiguration TextAnnotationConfiguration : categories TextAnnotationConfiguration : include_aliases TextAnnotationConfiguration : limit TextAnnotationConfiguration : matches_whole_text TextAnnotationConfiguration : model TextAnnotationConfiguration : sources TextAnnotationConfiguration : token_exclusion_list

Slots

Name	Cardinality and Range	Description	Inheritance
matches_whole_text	0..1 Boolean	If true, then only grounding is performed, and the entire text is used as the…	direct
sources	0..* String		direct
limit	0..1 Integer	The maximum number of annotations to return	direct
token_exclusion_list	0..* String	A list of tokens to exclude from the annotation process	direct
categories	0..* String	A list of named entity categories to include	direct
model	0..1 String	The name of the model to use for annotation	direct
include_aliases	0..1 Boolean	If true, then the aliases (synonyms) of the matched entity are included in th…	direct

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/oak/text_annotator

Mappings

Mapping Type	Mapped Value
self	ann:TextAnnotationConfiguration
native	ann:TextAnnotationConfiguration

LinkML Source

Direct

```yaml name: TextAnnotationConfiguration description: configuration for search from_schema: https://w3id.org/oak/text_annotator attributes: matches_whole_text: name: matches_whole_text description: If true, then only grounding is performed, and the entire text is used as the match string. from_schema: https://w3id.org/oak/text_annotator aliases: - grounding_mode rank: 1000 domain_of: - TextAnnotationConfiguration - TextAnnotation range: boolean sources: name: sources from_schema: https://w3id.org/oak/text_annotator rank: 1000 multivalued: true domain_of: - TextAnnotationConfiguration limit: name: limit description: The maximum number of annotations to return from_schema: https://w3id.org/oak/text_annotator rank: 1000 domain_of: - TextAnnotationConfiguration range: integer token_exclusion_list: name: token_exclusion_list description: A list of tokens to exclude from the annotation process from_schema: https://w3id.org/oak/text_annotator rank: 1000 multivalued: true domain_of: - TextAnnotationConfiguration categories: name: categories description: A list of named entity categories to include. from_schema: https://w3id.org/oak/text_annotator rank: 1000 multivalued: true domain_of: - TextAnnotationConfiguration model: name: model description: The name of the model to use for annotation. The specifics of this are implementation-dependent. from_schema: https://w3id.org/oak/text_annotator rank: 1000 domain_of: - TextAnnotationConfiguration range: string include_aliases: name: include_aliases description: If true, then the aliases (synonyms) of the matched entity are included in the annotation results. from_schema: https://w3id.org/oak/text_annotator rank: 1000 domain_of: - TextAnnotationConfiguration range: boolean

</details>

### Induced

<details>
```yaml
name: TextAnnotationConfiguration
description: configuration for search
from_schema: https://w3id.org/oak/text_annotator
attributes:
  matches_whole_text:
    name: matches_whole_text
    description: If true, then only grounding is performed, and the entire text is
      used as the match string.
    from_schema: https://w3id.org/oak/text_annotator
    aliases:
    - grounding_mode
    rank: 1000
    alias: matches_whole_text
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    - TextAnnotation
    range: boolean
  sources:
    name: sources
    from_schema: https://w3id.org/oak/text_annotator
    rank: 1000
    multivalued: true
    alias: sources
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    range: string
  limit:
    name: limit
    description: The maximum number of annotations to return
    from_schema: https://w3id.org/oak/text_annotator
    rank: 1000
    alias: limit
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    range: integer
  token_exclusion_list:
    name: token_exclusion_list
    description: A list of tokens to exclude from the annotation process
    from_schema: https://w3id.org/oak/text_annotator
    rank: 1000
    multivalued: true
    alias: token_exclusion_list
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    range: string
  categories:
    name: categories
    description: A list of named entity categories to include.
    from_schema: https://w3id.org/oak/text_annotator
    rank: 1000
    multivalued: true
    alias: categories
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    range: string
  model:
    name: model
    description: The name of the model to use for annotation. The specifics of this
      are implementation-dependent.
    from_schema: https://w3id.org/oak/text_annotator
    rank: 1000
    alias: model
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    range: string
  include_aliases:
    name: include_aliases
    description: If true, then the aliases (synonyms) of the matched entity are included
      in the annotation results.
    from_schema: https://w3id.org/oak/text_annotator
    rank: 1000
    alias: include_aliases
    owner: TextAnnotationConfiguration
    domain_of:
    - TextAnnotationConfiguration
    range: boolean