Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation
Record Components:
endIndex - The index of the last character of the URL citation in the message.
startIndex - The index of the first character of the URL citation in the message.
title - The title of the web resource.
url - The URL of the web resource.
Enclosing class:
OpenAiApi.ChatCompletionMessage.Annotation
public static record OpenAiApi.ChatCompletionMessage.Annotation.UrlCitation(Integer endIndex, Integer startIndex, String title, String url) extends Record
A URL citation when using web search.

  • Constructor Details

    • UrlCitation

      public UrlCitation(Integer endIndex, Integer startIndex, String title, String url)
      Creates an instance of a UrlCitation record class.
      Parameters:
      endIndex - the value for the endIndex record component
      startIndex - the value for the startIndex record component
      title - the value for the title record component
      url - the value for the url 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.

    • endIndex

      public Integer endIndex()
      Returns the value of the endIndex record component.
      Returns:
      the value of the endIndex record component

    • startIndex

      public Integer startIndex()
      Returns the value of the startIndex record component.
      Returns:
      the value of the startIndex record component

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • url

      public String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component