NewsArticle interface

Package:

@azure/cognitiveservices-newssearch

Defines a news article.

Properties

alternateName	An alias for the item NOTE: This property will not be serialized. It can only be populated by the server.
bingId	An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
category	The news category that the article belongs to. For example, Sports. If the news category cannot be determined, the article does not include this field. NOTE: This property will not be serialized. It can only be populated by the server.
clusteredArticles	A list of related news articles. NOTE: This property will not be serialized. It can only be populated by the server.
datePublished	The date on which the CreativeWork was published. NOTE: This property will not be serialized. It can only be populated by the server.
description	A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.
headline	A Boolean value that indicates whether the news article is a headline. If true, the article is a headline. The article includes this field only for news categories requests that do not specify the category query parameter. NOTE: This property will not be serialized. It can only be populated by the server.
id	A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
image	An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
provider	The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.
thumbnailUrl	The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.
url	The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
video	A video of the item. NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl	The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.
wordCount	The number of words in the text of the Article. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

alternateName

An alias for the item NOTE: This property will not be serialized. It can only be populated by the server.

alternateName?: string

Property Value

string

bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.

bingId?: string

Property Value

string

category

The news category that the article belongs to. For example, Sports. If the news category cannot be determined, the article does not include this field. NOTE: This property will not be serialized. It can only be populated by the server.

category?: string

Property Value

string

clusteredArticles

A list of related news articles. NOTE: This property will not be serialized. It can only be populated by the server.

clusteredArticles?: NewsArticle[]

Property Value

NewsArticle[]

datePublished

The date on which the CreativeWork was published. NOTE: This property will not be serialized. It can only be populated by the server.

datePublished?: string

Property Value

string

description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

headline

A Boolean value that indicates whether the news article is a headline. If true, the article is a headline. The article includes this field only for news categories requests that do not specify the category query parameter. NOTE: This property will not be serialized. It can only be populated by the server.

headline?: boolean

Property Value

boolean

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

image

An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.

image?: ImageObject

Property Value

ImageObject

name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

provider

The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.

provider?: ThingUnion[]

Property Value

ThingUnion[]

thumbnailUrl

The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.

thumbnailUrl?: string

Property Value

string

url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string

video

A video of the item. NOTE: This property will not be serialized. It can only be populated by the server.

video?: VideoObject

Property Value

VideoObject

webSearchUrl

The URL To Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string

wordCount

The number of words in the text of the Article. NOTE: This property will not be serialized. It can only be populated by the server.

wordCount?: number

Property Value

number