Create a Run

A Run can be started with an initial prompt (human message).

​

Options

​

id

The ID of the Run. If not provided, one will be generated automatically. If provided, and the run already exists, the existing run will be returned.

​

initialPrompt

An initial prompt for the run (human message) .

​

name

A human readable name for the run, this will be shown in the Runs pane of the Playground. If none is provided, one will be generated automatically based on the initialPrompt.

​

agentId

If the configuration should be inherited from an Agent.

agentId: 'XXXXXXXX' // ID of the Agent

​

input

A structured input object which is merged with the initialPrompt. If the run specifies an Agent with an inputSchema, this will be validated against that schema.

input: {} // Optional: Structured Input

​

resultSchema

By default, a Run’s result object shape is at the discretion of the model. A specific output structure can be enforced by providing a resultSchema value in JSON Schema form.

The Run will be forced to return a result in the provided format or null if this is not possible.

"resultSchema": {
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string"
    },
    "required": [
      "orderId"
    ]
  }
}

​

onStatusChange

As an alternative to retrieving a Run result via the API or calling the SDK’s poll() function, you can provide an Inferable function as a handler which will be called each time the status of the run changes.

Using an onStatusChange handler to receive Run results provides the same durability guarantees as any other Inferable function, this is especially helpful in the case of Runs which may take some time to complete or pause for approval.

When registering an onStatusChange handler via the SDK, the function must accept an object in the correct format. Each SDK provides a helper type for registering the onStatusChange handler

{
  "onStatusChange": {
    "function": {
      "function": "result",
      "tools": "default"
    }
  },
}

​

attachedFunctions

By default, a Run will have access to all functions within the cluster (including the Standard Library, you can explicitly attach a set of desired functions by setting the attachedFunctions property.

"attachedFunctions": [
  {
    "service": "default",
    "function": "myFunctionName"
  },
  {
    "service": "inferable",
    "function": "accessKnowledgeArtifacts"
  }
]

​

tags

Key-Value tags which can be attached to the run. Runs are queryable by these values using the API. Tags are useful for maintaining a relation between Inferable Runs and entities within your systems, for example, attaching an orderId to Runs.

"tags": {
  "orderId": "abc-123"
}

​

context

Context object which is passed to all calls in the Run. This can be used to vary the behavior of functions in a Run, for example based on a timezone value.

The values provided are available within a function’s second argument which also contains any authContext returned from default.handleCustomAuth.

inferable.tools.register({
  name: "checkTime",
  func: async (_input, context) => {
    //{
    //  runContext: {
    //    timeZone: "Australia/Adelaide"
    //  },
    //   authContext: null
    //}
    cosnole.log(context);
  },
});

const run = await inferable.run({
  initialPrompt: "What is the current time?",
  context: {
    timeZone: "Australia/Adelaide",
  },
});

​

reasoningTraces

When enabled, the Run will produce a reasoning trace for each function call.

Defaults to true.

​

callSummarization

When enabled, the Run will attempt to auto-summarize functionr results that are too large (>10k characters) to include in the agent context.

Defaults to false.

​

interactive

When disabled, the run will not allow additional messages to be added.

Defaults to true.