Share via

ContractualRulesMediaAttribution interface

  • Reference
Package:
@azure/cognitiveservices-entitysearch

Defines a contractual rule for media 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.
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.
url

The URL that you use to create of hyperlink of the media content. For example, if the target is an image, you would use the URL to make the image clickable. NOTE: This property will not be serialized. It can only be populated by the server.

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

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

url

The URL that you use to create of hyperlink of the media content. For example, if the target is an image, you would use the URL to make the image clickable. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string