Citation¶

class oci.generative_ai_agent_runtime.models.Citation(**kwargs)¶

Bases: object

The source of information for the agent’s response.

Methods

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

Attributes

`doc_id`	Gets the doc_id of this Citation.
`metadata`	Gets the metadata of this Citation.
`page_numbers`	Gets the page_numbers of this Citation.
`source_location`	Gets the source_location of this Citation.
`source_text`	Gets the source_text of this Citation.
`title`	Gets the title of this Citation.

__init__(**kwargs)¶

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

Parameters:

source_text (str) – The value to assign to the source_text property of this Citation.
source_location (oci.generative_ai_agent_runtime.models.SourceLocation) – The value to assign to the source_location property of this Citation.
title (str) – The value to assign to the title property of this Citation.
doc_id (str) – The value to assign to the doc_id property of this Citation.
page_numbers (list[int]) – The value to assign to the page_numbers property of this Citation.
metadata (dict(str, object)) – The value to assign to the metadata property of this Citation.

doc_id¶

Gets the doc_id of this Citation. The id of the retrieved document, if available.

Returns:	The doc_id of this Citation.
Return type:	str

metadata¶

Gets the metadata of this Citation. The metadata of the retrieved document, if available.

Returns:	The metadata of this Citation.
Return type:	dict(str, object)

page_numbers¶

Gets the page_numbers of this Citation. The page numbers on the retrieved document, if available.

Returns:	The page_numbers of this Citation.
Return type:	list[int]

source_location¶

Gets the source_location of this Citation.

Returns:	The source_location of this Citation.
Return type:	oci.generative_ai_agent_runtime.models.SourceLocation

source_text¶

Gets the source_text of this Citation. The text that’s the source for the agent’s response.

Returns:	The source_text of this Citation.
Return type:	str

title¶

Gets the title of this Citation. The title of the source text, if available.

Returns:	The title of this Citation.
Return type:	str