Citation¶
-
class
oci.generative_ai_inference.models.
Citation
(**kwargs)¶ Bases:
object
A section of the generated reply which cites external knowledge.
Methods
__init__
(**kwargs)Initializes a new Citation object with values from keyword arguments. Attributes
document_ids
[Required] Gets the document_ids of this Citation. end
[Required] Gets the end of this Citation. start
[Required] Gets the start of this Citation. text
[Required] Gets the text 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: - start (int) – The value to assign to the start property of this Citation.
- end (int) – The value to assign to the end property of this Citation.
- text (str) – The value to assign to the text property of this Citation.
- document_ids (list[str]) – The value to assign to the document_ids property of this Citation.
-
document_ids
¶ [Required] Gets the document_ids of this Citation. Identifiers of documents cited by this section of the generated reply.
Returns: The document_ids of this Citation. Return type: list[str]
-
end
¶ [Required] Gets the end of this Citation. The index of text that the citation ends after, counting from zero.
Returns: The end of this Citation. Return type: int
-
start
¶ [Required] Gets the start of this Citation. The index of text that the citation starts at, counting from zero.
Returns: The start of this Citation. Return type: int
-
text
¶ [Required] Gets the text of this Citation. The text of the citation
Returns: The text of this Citation. Return type: str
-