llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.codegen

org.llm4s.codegen

package org.llm4s.codegen

Members list

Type members

Classlikes

object CodeGenExample

Example demonstrating how to use the CodeWorker to perform code tasks.

Example demonstrating how to use the CodeWorker to perform code tasks.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class CodeTask(description: String, maxSteps: Option[Int], sourceDirectory: Option[String])

Represents a code task to be performed by the CodeWorker.

Represents a code task to be performed by the CodeWorker.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class CodeTaskResult(success: Boolean, message: String, logs: Seq[String])

Represents the result of a code task execution.

Represents the result of a code task execution.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class CodeWorker(sourceDirectory: String, imageName: String, hostPort: Int, client: LLMClient) extends AutoCloseable

A worker for code generation and manipulation tasks. CodeWorker combines a workspace environment with an LLM agent to handle tasks involving code base understanding, modification, and generation.

A worker for code generation and manipulation tasks. CodeWorker combines a workspace environment with an LLM agent to handle tasks involving code base understanding, modification, and generation.

Value parameters

sourceDirectory

The directory containing the codebase to work with

Attributes

Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
object WorkspaceConfigSupport

PureConfig-based loader for workspace settings.

PureConfig-based loader for workspace settings.

This mirrors the behavior of WorkspaceSettings.load(), but is implemented in terms of llm4s.* HOCON keys and the standard PureConfig flow.

Keys (with precedence):

  • llm4s.workspace.dir | WORKSPACE_DIR
  • llm4s.workspace.image | WORKSPACE_IMAGE
  • llm4s.workspace.port | WORKSPACE_PORT
  • llm4s.workspace.traceLogPath | WORKSPACE_TRACE_LOG

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class WorkspaceSettings(workspaceDir: String, imageName: String, hostPort: Int, traceLogPath: String)

Configuration settings for workspace environment.

Configuration settings for workspace environment.

Defines the directory, Docker image, port, and logging configuration for the containerized code workspace.

Value parameters

hostPort

host port for workspace communication

imageName

Docker image name for the workspace container

traceLogPath

path for writing trace/log output

workspaceDir

directory path containing the codebase to work with

Attributes

See also

WorkspaceConfigSupport for loading settings from configuration

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WorkspaceSettings

Companion object with default workspace settings.

Companion object with default workspace settings.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with