Share via

ContractualRulesTextAttribution interface

  • Reference
Package:
@azure/cognitiveservices-entitysearch

Defines a contractual rule for text attribution.

Properties

mustBeCloseToContent

A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller's discretion. NOTE: This property will not be serialized. It can only be populated by the server.
optionalForListDisplay

Indicates whether this provider's attribution is optional. NOTE: This property will not be serialized. It can only be populated by the server.
targetPropertyName

The name of the field that the rule applies to. NOTE: This property will not be serialized. It can only be populated by the server.
text

The attribution text. Text attribution applies to the entity as a whole and should be displayed immediately following the entity presentation. If there are multiple text or link attribution rules that do not specify a target, you should concatenate them and display them using a "Data from:" label.

Property Details

mustBeCloseToContent

A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller's discretion. NOTE: This property will not be serialized. It can only be populated by the server.

mustBeCloseToContent?: boolean

Property Value

boolean

optionalForListDisplay

Indicates whether this provider's attribution is optional. NOTE: This property will not be serialized. It can only be populated by the server.

optionalForListDisplay?: boolean

Property Value

boolean

targetPropertyName

The name of the field that the rule applies to. NOTE: This property will not be serialized. It can only be populated by the server.

targetPropertyName?: string

Property Value

string

text

The attribution text. Text attribution applies to the entity as a whole and should be displayed immediately following the entity presentation. If there are multiple text or link attribution rules that do not specify a target, you should concatenate them and display them using a "Data from:" label.

text: string

Property Value

string