Share via

MessageTextUrlCitationAnnotation interface

Package:
@azure/ai-agents

A citation within the message that points to a specific URL associated with the message. Generated when the agent uses tools such as 'bing_grounding' to search the Internet.

Extends
MessageTextAnnotation

Properties

endIndex

The last text index associated with this text annotation.
startIndex

The first text index associated with this text annotation.
type

The object type, which is always 'url_citation'.
urlCitation

The details of the URL citation.

Inherited Properties

text

The textual content associated with this text annotation item.

Property Details

endIndex

The last text index associated with this text annotation.

endIndex?: number

Property Value

number

startIndex

The first text index associated with this text annotation.

startIndex?: number

Property Value

number

type

The object type, which is always 'url_citation'.

type: "url_citation"

Property Value

"url_citation"

urlCitation

The details of the URL citation.

urlCitation: MessageTextUrlCitationDetails

Property Value

MessageTextUrlCitationDetails

Inherited Property Details

text

The textual content associated with this text annotation item.

text: string

Property Value

string

Inherited From MessageTextAnnotation.text