@azure/cognitiveservices-websearch package

Classes

Web

Class representing a Web.

WebSearchClient
WebSearchClientContext

Interfaces

Answer

An interface representing Answer.

Article

An interface representing Article.

Computation

Defines an expression and its answer

CreativeWork

An interface representing CreativeWork.

ErrorModel

Defines the error that occurred.

ErrorResponse

The top-level response that represents a failed request.

Identifiable

Defines the identity of a resource.

ImageObject

Defines an image

Images

Defines an image answer

Intangible

An interface representing Intangible.

MediaObject

An interface representing MediaObject.

News

Defines a news answer.

NewsArticle

Defines a news article.

Places

Defines a local entity answer.

Query

Defines a search query.

QueryContext

Defines the query context that Bing used for the request.

RankingRankingGroup

Defines a search results group, such as mainline.

RankingRankingItem

Defines a search result item to display

RankingRankingResponse

Defines where on the search results page content should be placed and in what order.

RelatedSearchesRelatedSearchAnswer

Defines a list of related queries made by others.

Response

Defines a response. All schemas that could be returned at the root of a response should inherit from this

ResponseBase

An interface representing ResponseBase.

SearchResponse

Defines the top-level object that the response includes when the request succeeds.

SearchResultsAnswer

An interface representing SearchResultsAnswer.

SpellSuggestions

Defines a suggested query string that likely represents the user's intent. The search results include this response if Bing determines that the user may have intended to search for something different. For example, if the user searches for alon brown, Bing may determine that the user likely intended to search for Alton Brown instead (based on past searches by others of Alon Brown).

StructuredValue

An interface representing StructuredValue.

Thing

An interface representing Thing.

TimeZone

Defines the data and time of one or more geographic locations.

TimeZoneTimeZoneInformation

Defines a date and time for a geographical location.

VideoObject

Defines a video object that is relevant to the query.

Videos

Defines a video answer.

WebMetaTag

Defines a webpage's metadata.

WebPage

Defines a webpage that is relevant to the query.

WebSearchClientOptions

An interface representing WebSearchClientOptions.

WebSearchOptionalParams

Optional Parameters.

WebWebAnswer

Defines a list of relevant webpage links.

WebWebGrouping

An interface representing WebWebGrouping.

Type Aliases

AnswerType

Defines values for AnswerType. Possible values include: 'WebPages', 'Images', 'SpellSuggestions', 'News', 'RelatedSearches', 'Videos', 'Computation', 'TimeZone'

AnswerUnion

Contains the possible cases for Answer.

ArticleUnion

Contains the possible cases for Article.

CreativeWorkUnion

Contains the possible cases for CreativeWork.

ErrorCode

Defines values for ErrorCode. Possible values include: 'None', 'ServerError', 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'

ErrorSubCode

Defines values for ErrorSubCode. Possible values include: 'UnexpectedError', 'ResourceError', 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue', 'HttpNotAllowed', 'Blocked', 'AuthorizationMissing', 'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired'

Freshness

Defines values for Freshness. Possible values include: 'Day', 'Week', 'Month'

IdentifiableUnion

Contains the possible cases for Identifiable.

IntangibleUnion

Contains the possible cases for Intangible.

MediaObjectUnion

Contains the possible cases for MediaObject.

ResponseBaseUnion

Contains the possible cases for ResponseBase.

ResponseUnion

Contains the possible cases for Response.

SafeSearch

Defines values for SafeSearch. Possible values include: 'Off', 'Moderate', 'Strict'

SearchResultsAnswerUnion

Contains the possible cases for SearchResultsAnswer.

TextFormat

Defines values for TextFormat. Possible values include: 'Raw', 'Html'

ThingUnion

Contains the possible cases for Thing.

WebSearchResponse

Contains response data for the search operation.