Package version:

Interface MessageDeltaTextUrlCitationAnnotation

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.

interface MessageDeltaTextUrlCitationAnnotation {
    endIndex?: number;
    index: number;
    startIndex?: number;
    type: "url_citation";
    urlCitation: MessageDeltaTextUrlCitationDetails;
}

Hierarchy (view full)

Properties

endIndex? index startIndex? type urlCitation

Properties

OptionalendIndex

endIndex?: number

The last text index associated with this text annotation.

index

index: number

The index of the annotation within a text content part.

OptionalstartIndex

startIndex?: number

The first text index associated with this text annotation.

type

type

The object type, which is always 'url_citation'.

urlCitation

urlCitation: MessageDeltaTextUrlCitationDetails

The details of the URL citation.

Settings

Member Visibility