Citation.Builder (Oracle Cloud Infrastructure Java SDK - 3.63.0)

java.lang.Object
- com.oracle.bmc.generativeaiagentruntime.model.Citation.Builder

Enclosing class:: Citation

public static class Citation.Builder
extends Object

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Citation`	`build()`
`Citation.Builder`	`copy(Citation model)`
`Citation.Builder`	`docId(String docId)`	The id of the retrieved document, if available.
`Citation.Builder`	`metadata(Map<String,Object> metadata)`	The metadata of the retrieved document, if available.
`Citation.Builder`	`pageNumbers(List<Integer> pageNumbers)`	The page numbers on the retrieved document, if available.
`Citation.Builder`	`sourceLocation(SourceLocation sourceLocation)`
`Citation.Builder`	`sourceText(String sourceText)`	The text that’s the source for the agent’s response.
`Citation.Builder`	`title(String title)`	The title of the source text, if available.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - sourceText
```
public Citation.Builder sourceText(String sourceText)
```
    The text that’s the source for the agent’s response.
    
    Parameters:
    
    sourceText - the value to set
    
    Returns:
    
    this builder
  - sourceLocation
```
public Citation.Builder sourceLocation(SourceLocation sourceLocation)
```
  - title
```
public Citation.Builder title(String title)
```
    The title of the source text, if available.
    
    Parameters:
    
    title - the value to set
    
    Returns:
    
    this builder
  - docId
```
public Citation.Builder docId(String docId)
```
    The id of the retrieved document, if available.
    
    Parameters:
    
    docId - the value to set
    
    Returns:
    
    this builder
  - pageNumbers
```
public Citation.Builder pageNumbers(List<Integer> pageNumbers)
```
    The page numbers on the retrieved document, if available.
    
    Parameters:
    
    pageNumbers - the value to set
    
    Returns:
    
    this builder
  - metadata
```
public Citation.Builder metadata(Map<String,Object> metadata)
```
    The metadata of the retrieved document, if available.
    
    Parameters:
    
    metadata - the value to set
    
    Returns:
    
    this builder
  - build
```
public Citation build()
```
  - copy
```
public Citation.Builder copy(Citation model)
```