CitationAppearance Class

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

CitationAppearance(*, name: str, text: str | None = None, url: str | None = None, abstract: str, icon: CitationIconName | None = None, keywords: List[str] | None = None, usageInfo: CitationUsageInfo | None = None, **extra_data: Any)

Keyword-Only Parameters

Name Description
name
Required
text
Default value: None
url
Default value: None
abstract
Required
icon
Default value: None
keywords
Default value: None
usageInfo
Default value: None

Methods

check_abstract
check_keywords
check_name

check_abstract 

check_abstract(value: Any) -> Any

Parameters

Name Description
value
Required

check_keywords 

check_keywords(value: Any) -> Any

Parameters

Name Description
value
Required

check_name 

check_name(value: Any) -> Any

Parameters

Name Description
value
Required

Attributes

abstract

Extract of the referenced content (max length 160)

abstract: str

icon

Information about the citation's icon

icon: CitationIconName | None

keywords

Keywords (max length 3) (max keyword length 28)

keywords: List[str] | None

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_config: ClassVar[ConfigDict] = {'alias_generator': AliasGenerator(alias=None, validation_alias=<staticmethod(<function CustomBaseModel.validation_alias_generator>)>, serialization_alias=<staticmethod(<function CustomBaseModel.serialization_alias_generator>)>), 'arbitrary_types_allowed': True, 'extra': 'allow', 'populate_by_name': True, 'serialize_by_alias': True, 'validate_by_alias': True, 'validate_by_name': True}

name

Name of the document (max length 80)

name: str

text

Stringified adaptive card with additional information about the citation. It is rendered within a modal

text: str | None

url

URL of the document. This will make the name of the citation clickable and direct the user to the specified URL

url: str | None

usage_info

Sensitivity content information

usage_info: CitationUsageInfo | None