Record Class Citations

java.lang.Object
java.lang.Record
com.github.copilot.generated.Citations
@Generated("copilot-sdk-codegen") public record Citations(List<CitationSource> sources, List<CitationSpan> spans) extends Record
Provider-agnostic citations linking spans of the assistant's response to their supporting sources.
Since:
1.0.0

  • Constructor Details

    • Citations

      public Citations(List<CitationSource> sources, List<CitationSpan> spans)
      Creates an instance of a Citations record class.
      Parameters:
      sources - the value for the sources record component
      spans - the value for the spans record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • sources

      public List<CitationSource> sources()
      Returns the value of the sources record component.
      Returns:
      the value of the sources record component

    • spans

      public List<CitationSpan> spans()
      Returns the value of the spans record component.
      Returns:
      the value of the spans record component