UrlCitation

class oci.generative_ai_inference.models.UrlCitation(**kwargs)

Bases: object

Contains metadata for a cited URL included in the assistant’s response. Includes the cited URL and title, and the character range (start and end indices) in the response content where the citation applies.

Methods

__init__(**kwargs) Initializes a new UrlCitation object with values from keyword arguments.

Attributes

end_index Gets the end_index of this UrlCitation.
start_index Gets the start_index of this UrlCitation.
title Gets the title of this UrlCitation.
url Gets the url of this UrlCitation.
__init__(**kwargs)

Initializes a new UrlCitation object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • start_index (int) – The value to assign to the start_index property of this UrlCitation.
  • end_index (int) – The value to assign to the end_index property of this UrlCitation.
  • title (str) – The value to assign to the title property of this UrlCitation.
  • url (str) – The value to assign to the url property of this UrlCitation.
end_index

Gets the end_index of this UrlCitation. End character index in the response where the citation ends.

Returns:The end_index of this UrlCitation.
Return type:int
start_index

Gets the start_index of this UrlCitation. Start character index in the response where the citation begins.

Returns:The start_index of this UrlCitation.
Return type:int
title

Gets the title of this UrlCitation. Title of the cited source.

Returns:The title of this UrlCitation.
Return type:str
url

Gets the url of this UrlCitation. URL of the cited source.

Returns:The url of this UrlCitation.
Return type:str