Annotation (Oracle Cloud Infrastructure Java SDK - 3.73.0)

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiinference.model.Annotation

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class Annotation
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
An annotation attached to the assistant’s message, used to represent additional metadata such as citations.
Note: Objects should always be created or deserialized using the Annotation.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Annotation.Builder, which maintain a set of all explicitly set fields called Annotation.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Annotation.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor Description

Annotation(String type, UrlCitation urlCitation)
Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Annotation.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getType()`	Type of annotation.
`UrlCitation`	`getUrlCitation()`
`int`	`hashCode()`
`Annotation.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

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

- Constructor Detail
  - Annotation
```
@Deprecated
@ConstructorProperties({"type","urlCitation"})
public Annotation(String type,
                  UrlCitation urlCitation)
```
    Deprecated.
- Method Detail
  - builder
```
public static Annotation.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public Annotation.Builder toBuilder()
```
  - getType
```
public String getType()
```
    Type of annotation.
    For web search citations, this is url_citation.
    
    Returns:
    
    the value
  - getUrlCitation
```
public UrlCitation getUrlCitation()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel