ContractualRulesLicenseAttribution interface

Package:

@azure/cognitiveservices-entitysearch

Defines a contractual rule for license attribution.

Properties

license	The license under which the content may be used. NOTE: This property will not be serialized. It can only be populated by the server.
licenseNotice	The license to display next to the targeted field. NOTE: This property will not be serialized. It can only be populated by the server.
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.
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.

Property Details

license

The license under which the content may be used. NOTE: This property will not be serialized. It can only be populated by the server.

license?: License

Property Value

License

licenseNotice

The license to display next to the targeted field. NOTE: This property will not be serialized. It can only be populated by the server.

licenseNotice?: string

Property Value

string

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

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