Brave Summarizer Search API

Response Objects

# SummarizerSearchApiResponse

Top level response model for successful Summarizer Search API requests. The response will include the summarized content or answer based on the key. The API can also respond back with an error response based on the incompleted summarization request, invalid subscription keys, and rate limit events. Access to Summarizer requires a subscription to Pro AI plan.

Field	Type	Description
type	"summarizer"	The type of summarizer search API result. The value is always summarizer.
status	string	The current status of summarizer for the given key. The value can be either failed or complete.
title	string	The title for the summary.
summary	list [ SummaryMessage ]	Details for the summary message.
enrichments	SummaryEnrichments	Enrichments that can be added to the summary message.
followups	list [ string ]	Followup queries relevant to the current query.
entities_infos	dict [ string, SummaryEntityInfo ]	Details on the entities in the summary message.

# SummaryMessage

The summary message.

Field	Type	Description
type	string	The type of subset of a summary message. The value can be token (a text excerpt from the summary), enum_item (a summary entity), enum_start (describes the beginning of summary entities, which means the following item(s) in the summary list will be entities), or enum_end (the end of summary entities).
data	SummaryEntity | string	The summary entity or the explanation for the type field. For type enum_start the value can be ol or ul, which means an ordered list or an unordered list of entities follows respectively. For type enum_end there is no value. For type token the value is a text excerpt. For type enum_item the value is the SummaryEntity response model.

# TextLocation

Index based location in a text.

Field	Type	Description
start	int	The 0 based index, where the important part of the text starts.
end	int	The 0 based index, where the important part of the text ends.

# SummaryEntity

An entity in the summary message.

Field	Type	Description
uuid	string	A unique identifier for the entity.
name	string	The name of the entity.
url	string	The url where further details on the entity can be found.
text	string	A text message describing the entity.
images	list [ SummaryImage ]	The image associated with the entity.
highlight	list [ TextLocation ]	The location of the entity in the summary message.

# Thumbnail

Aggregated details representing a picture thumbnail.

Field	Type	Description
src	string	The served url of the picture thumbnail.
original	string	The original url of the image.

# ImageProperties

Metadata on an image.

Field	Type	Description
url	string	The image URL.

# Image

A model describing an image

Field	Type	Description
thumbnail	Thumbnail	The thumbnail associated with the image.
url	string	The url of the image.
properties	ImageProperties	Metadata on the image.

# SummaryImage (Image)

An image associated with the summary.

Field	Type	Description
text	string	Text associated with the image.

# SummaryEnrichments

Enrichments associated with the summary message.

Field	Type	Description
raw	string	The raw summary message.
images	list [ SummaryImage ]	The images associated with the summary.
qa	list [ SummaryAnswer ]	The answers in the summary message.
entities	list [ SummaryEntity ]	The entities in the summary message.
context	list [ SummaryContext ]	References based on which the summary was built.

# SummaryAnswer

The answer if the query is a question.

Field	Type	Description
answer	string	The answer text.
score	float	A score associated with the answer.
highlight	TextLocation	The location of the answer in the summary message.

# MetaUrl

Aggregated information about a url.

Field	Type	Description
scheme	string	The protocol scheme extracted from the url.
netloc	string	The network location part extracted from the url.
hostname	string	The lowercased domain name extracted from the url.
favicon	string	The favicon used for the url.
path	string	The hierarchical path of the url useful as a display string.

# SummaryContext

A reference for the summary.

Field	Type	Description
title	string	The title of the reference.
url	string	The url where the reference can be found.
meta_url	MetaUrl	Details on the url associated with the reference.

# SummaryEntityInfo

Details on the entity in the summary message.

Field	Type	Description
provider	string	The name of the provider.
description	string	Description of the entity.