WebPage interface

Package:

@azure/cognitiveservices-customsearch

Defines a webpage that is relevant to the query.

Properties

bingId	An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
dateLastCrawled	The last time that Bing crawled the webpage. The date is in the form, YYYY-MM-DDTHH:MM:SS. For example, 2015-04-13T05:23:39. NOTE: This property will not be serialized. It can only be populated by the server.
deepLinks	A list of links to related content that Bing found in the website that contains this webpage. The Webpage object in this context includes only the name, url, urlPingSuffix, and snippet fields. 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.
displayUrl	The display URL of the webpage. The URL is meant for display purposes only and is not well formed. 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.
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.
searchTags	A list of search tags that the webpage owner specified on the webpage. The API returns only indexed search tags. The name field of the MetaTag object contains the indexed search tag. Search tags begin with search.* (for example, search.assetId). The content field contains the tag's value. NOTE: This property will not be serialized. It can only be populated by the server.
snippet	A snippet of text from the webpage that describes its contents. NOTE: This property will not be serialized. It can only be populated by the server.
text	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.
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.

Property Details

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

dateLastCrawled

The last time that Bing crawled the webpage. The date is in the form, YYYY-MM-DDTHH:MM:SS. For example, 2015-04-13T05:23:39. NOTE: This property will not be serialized. It can only be populated by the server.

dateLastCrawled?: string

Property Value

string

deepLinks

A list of links to related content that Bing found in the website that contains this webpage. The Webpage object in this context includes only the name, url, urlPingSuffix, and snippet fields. NOTE: This property will not be serialized. It can only be populated by the server.

deepLinks?: WebPage[]

Property Value

WebPage[]

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

displayUrl

The display URL of the webpage. The URL is meant for display purposes only and is not well formed. NOTE: This property will not be serialized. It can only be populated by the server.

displayUrl?: string

Property Value

string

id

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

id?: string

Property Value

string

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[]

searchTags

A list of search tags that the webpage owner specified on the webpage. The API returns only indexed search tags. The name field of the MetaTag object contains the indexed search tag. Search tags begin with search.* (for example, search.assetId). The content field contains the tag's value. NOTE: This property will not be serialized. It can only be populated by the server.

searchTags?: WebMetaTag[]

Property Value

WebMetaTag[]

snippet

A snippet of text from the webpage that describes its contents. NOTE: This property will not be serialized. It can only be populated by the server.

snippet?: string

Property Value

string

text

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

text?: string

Property Value

string

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

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