BRbraintrustdata
Functions

Partially update function

Changed on

Partially update a function object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

patch/v1/function/{function_id}

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

function_idstring uuid required

Function id

Request body

namestring nullable

Name of the prompt

descriptionstring nullable

Textual description of the prompt

tagsstring[] nullable

A list of tags for the prompt

Response

Returns the function object

idstring uuid required

Unique identifier for the prompt

_xact_idstring required

The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the prompt (see the version parameter)

project_idstring uuid required

Unique identifier for the project that the prompt belongs under

log_id'p' required

A literal 'p' which identifies the object as a project prompt

org_idstring uuid required

Unique identifier for the organization

namestring required

Name of the prompt

slugstring required

Unique identifier for the prompt

descriptionstring nullable

Textual description of the prompt

createdstring date-time nullable

Date of prompt creation

tagsstring[] nullable

A list of tags for the prompt

metadataobject nullable

User-controlled metadata about the prompt

function_type'llm' | 'scorer' | 'task' | 'tool' | 'custom_view' | 'preprocessor' | 'facet' | 'classifier' | 'tag' | 'parameters' | 'sandbox' | 'null' nullable

Changes

  • 8f5039399f77Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 from the /// request property anyOf list

    • breaking

      the request property became not nullable

    • breaking

      the request property //////// became not nullable

    • breaking

      the request property ////////// became not nullable

    • breaking

      the request property /////////// became not nullable

    • breaking

      the request property //////// became not nullable

    • breaking

      the request property /// became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property /// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property /// became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///////// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property //////// became not nullable

    • breaking

      the request property //////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed the enum value undefined of the request property //

    • breaking

      removed the enum value undefined of the request property ////

    • breaking

      removed the enum value undefined of the request property ////

    • breaking

      removed the enum value undefined of the request property ////////////

    • breaking

      removed the enum value undefined of the request property /////////

    • breaking

      removed the enum value undefined of the request property ////////////

    • breaking

      removed the enum value undefined of the request property /////////

    • breaking

      removed the enum value undefined of the request property ////////

    • breaking

      removed the enum value undefined of the request property /////

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 to the /// request property anyOf list

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      the /////// request property's exclusiveMinimum was decreased from true to 0.00

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 to the /// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 from the /// response property anyOf list for the response status

    • info

      removed the undefined enum value from the // response property for the response status

    • info

      removed the undefined enum value from the //// response property for the response status

    • info

      removed the undefined enum value from the //// response property for the response status

    • info

      removed the undefined enum value from the //////////// response property for the response status

    • info

      removed the undefined enum value from the ///////// response property for the response status

    • info

      removed the undefined enum value from the //////////// response property for the response status

    • info

      removed the undefined enum value from the ///////// response property for the response status

    • info

      removed the undefined enum value from the //////// response property for the response status

    • info

      removed the undefined enum value from the ///// response property for the response status

  • aa86a5dee6e9Revision changes
    • info

      added subschema #10: simulation to the request property anyOf list

    • info

      added subschema #10: simulation to the response property anyOf list for the response status