Citation (extend-java-sdk 1.18.0 API)

java.lang.Object
- ai.extend.types.Citation

public final class Citation
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Citation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Citation.Builder`	`builder()`
`boolean`	`equals(java.lang.Object other)`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalProperties()`
`java.util.Optional<java.lang.String>`	`getFileId()`
`java.util.Optional<CitationPage>`	`getPage()`
`java.util.Optional<java.util.List<Polygon>>`	`getPolygon()`
`java.util.Optional<java.lang.String>`	`getReferenceText()`
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

- Method Detail
  - getFileId
```
public java.util.Optional<java.lang.String> getFileId()
```
    Returns:
    
    ID of the file the cited content was found in. On multifile runs, join this against the run's files array to determine which input file the citation refers to; on single-file runs it equals the run's file.id.
  - getPage
```
public java.util.Optional<CitationPage> getPage()
```
  - getReferenceText
```
public java.util.Optional<java.lang.String> getReferenceText()
```
    Returns:
    
    The text that was referenced
  - getPolygon
```
public java.util.Optional<java.util.List<Polygon>> getPolygon()
```
    Returns:
    
    Array of points defining the polygon around the referenced text
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAdditionalProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - builder
```
public static Citation.Builder builder()
```