Package dev.braintrust.api

Record Class BraintrustApiClient.Function

java.lang.Object
java.lang.Record
dev.braintrust.api.BraintrustApiClient.Function
Enclosing interface:
BraintrustApiClient
public static record BraintrustApiClient.Function(String id, String projectId, String orgId, String name, String slug, Optional<String> description, String created, Optional<Object> functionData, Optional<Object> promptData, Optional<List<String>> tags, Optional<Object> metadata, Optional<String> functionType, Optional<Object> origin, Optional<Object> functionSchema) extends Record
Represents a Braintrust function (scorer, prompt, tool, or task). Functions can be invoked remotely via the API.

  • Constructor Details

    • Function

      public Function(String id, String projectId, String orgId, String name, String slug, Optional<String> description, String created, Optional<Object> functionData, Optional<Object> promptData, Optional<List<String>> tags, Optional<Object> metadata, Optional<String> functionType, Optional<Object> origin, Optional<Object> functionSchema)
      Creates an instance of a Function record class.
      Parameters:
      id - the value for the id record component
      projectId - the value for the projectId record component
      orgId - the value for the orgId record component
      name - the value for the name record component
      slug - the value for the slug record component
      description - the value for the description record component
      created - the value for the created record component
      functionData - the value for the functionData record component
      promptData - the value for the promptData record component
      tags - the value for the tags record component
      metadata - the value for the metadata record component
      functionType - the value for the functionType record component
      origin - the value for the origin record component
      functionSchema - the value for the functionSchema 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.

    • id

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

    • projectId

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

    • orgId

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

    • name

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

    • slug

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

    • description

      public Optional<String> description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • created

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

    • functionData

      public Optional<Object> functionData()
      Returns the value of the functionData record component.
      Returns:
      the value of the functionData record component

    • promptData

      public Optional<Object> promptData()
      Returns the value of the promptData record component.
      Returns:
      the value of the promptData record component

    • tags

      public Optional<List<String>> tags()
      Returns the value of the tags record component.
      Returns:
      the value of the tags record component

    • metadata

      public Optional<Object> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component

    • functionType

      public Optional<String> functionType()
      Returns the value of the functionType record component.
      Returns:
      the value of the functionType record component

    • origin

      public Optional<Object> origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component

    • functionSchema

      public Optional<Object> functionSchema()
      Returns the value of the functionSchema record component.
      Returns:
      the value of the functionSchema record component