Documentation
¶
Overview ¶
Package generated provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r *mux.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r *mux.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options GorillaServerOptions) http.Handler
- type BadRequest
- type BundledFile
- type BundledFileContent
- type BundledFileContentEncoding
- type BundledFileType
- type ClassificationRoute
- type CommandDiagnostic
- type CreateFactoryBadRequest
- type CreateFactoryConflict
- type CurrentFactoryNotFound
- type Diagnostics
- type DispatchConsumedWorkRef
- type DispatchRequestEventMetadata
- type DispatchRequestEventPayload
- type DispatchResponseEventPayload
- type ErrorFamily
- type ErrorResponse
- type ErrorResponseCode
- type ErrorTarget
- type Factory
- type FactoryChangeEventPayload
- type FactoryEvent
- type FactoryEventContext
- type FactoryEventSchemaVersion
- type FactoryEventType
- type FactoryEvent_Payload
- func (t FactoryEvent_Payload) AsDispatchRequestEventPayload() (DispatchRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsDispatchResponseEventPayload() (DispatchResponseEventPayload, error)
- func (t FactoryEvent_Payload) AsFactoryChangeEventPayload() (FactoryChangeEventPayload, error)
- func (t FactoryEvent_Payload) AsFactoryStateResponseEventPayload() (FactoryStateResponseEventPayload, error)
- func (t FactoryEvent_Payload) AsInferenceRequestEventPayload() (InferenceRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsInferenceResponseEventPayload() (InferenceResponseEventPayload, error)
- func (t FactoryEvent_Payload) AsInitialStructureRequestEventPayload() (InitialStructureRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsModelRequestEventPayload() (ModelRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsModelResponseEventPayload() (ModelResponseEventPayload, error)
- func (t FactoryEvent_Payload) AsRelationshipChangeRequestEventPayload() (RelationshipChangeRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsRunRequestEventPayload() (RunRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsRunResponseEventPayload() (RunResponseEventPayload, error)
- func (t FactoryEvent_Payload) AsScriptRequestEventPayload() (ScriptRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsScriptResponseEventPayload() (ScriptResponseEventPayload, error)
- func (t FactoryEvent_Payload) AsWorkRequestEventPayload() (WorkRequestEventPayload, error)
- func (t FactoryEvent_Payload) AsWorkStateChangeEventPayload() (WorkStateChangeEventPayload, error)
- func (t *FactoryEvent_Payload) FromDispatchRequestEventPayload(v DispatchRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromDispatchResponseEventPayload(v DispatchResponseEventPayload) error
- func (t *FactoryEvent_Payload) FromFactoryChangeEventPayload(v FactoryChangeEventPayload) error
- func (t *FactoryEvent_Payload) FromFactoryStateResponseEventPayload(v FactoryStateResponseEventPayload) error
- func (t *FactoryEvent_Payload) FromInferenceRequestEventPayload(v InferenceRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromInferenceResponseEventPayload(v InferenceResponseEventPayload) error
- func (t *FactoryEvent_Payload) FromInitialStructureRequestEventPayload(v InitialStructureRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromModelRequestEventPayload(v ModelRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromModelResponseEventPayload(v ModelResponseEventPayload) error
- func (t *FactoryEvent_Payload) FromRelationshipChangeRequestEventPayload(v RelationshipChangeRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromRunRequestEventPayload(v RunRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromRunResponseEventPayload(v RunResponseEventPayload) error
- func (t *FactoryEvent_Payload) FromScriptRequestEventPayload(v ScriptRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromScriptResponseEventPayload(v ScriptResponseEventPayload) error
- func (t *FactoryEvent_Payload) FromWorkRequestEventPayload(v WorkRequestEventPayload) error
- func (t *FactoryEvent_Payload) FromWorkStateChangeEventPayload(v WorkStateChangeEventPayload) error
- func (t FactoryEvent_Payload) MarshalJSON() ([]byte, error)
- func (t *FactoryEvent_Payload) MergeDispatchRequestEventPayload(v DispatchRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeDispatchResponseEventPayload(v DispatchResponseEventPayload) error
- func (t *FactoryEvent_Payload) MergeFactoryChangeEventPayload(v FactoryChangeEventPayload) error
- func (t *FactoryEvent_Payload) MergeFactoryStateResponseEventPayload(v FactoryStateResponseEventPayload) error
- func (t *FactoryEvent_Payload) MergeInferenceRequestEventPayload(v InferenceRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeInferenceResponseEventPayload(v InferenceResponseEventPayload) error
- func (t *FactoryEvent_Payload) MergeInitialStructureRequestEventPayload(v InitialStructureRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeModelRequestEventPayload(v ModelRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeModelResponseEventPayload(v ModelResponseEventPayload) error
- func (t *FactoryEvent_Payload) MergeRelationshipChangeRequestEventPayload(v RelationshipChangeRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeRunRequestEventPayload(v RunRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeRunResponseEventPayload(v RunResponseEventPayload) error
- func (t *FactoryEvent_Payload) MergeScriptRequestEventPayload(v ScriptRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeScriptResponseEventPayload(v ScriptResponseEventPayload) error
- func (t *FactoryEvent_Payload) MergeWorkRequestEventPayload(v WorkRequestEventPayload) error
- func (t *FactoryEvent_Payload) MergeWorkStateChangeEventPayload(v WorkStateChangeEventPayload) error
- func (t *FactoryEvent_Payload) UnmarshalJSON(b []byte) error
- type FactoryGuard
- type FactoryName
- type FactorySaveMode
- type FactorySessionSummary
- type FactorySessionTarget
- type FactorySessionTargetRef
- type FactorySessionTargetRefKind
- type FactoryState
- type FactoryStateResponseEventPayload
- type FactoryValidationResult
- type FactoryValidationSeverity
- type FactoryValidationSubject
- type FactoryValidationSubjectLocation
- type FactoryValidationSubjectType
- type FactoryValidationTarget
- type FactoryWorldMutationView
- type FactoryWorldProviderDiagnostic
- type FactoryWorldRenderedPromptDiagnostic
- type FactoryWorldRunnerBaselineCapability
- type FactoryWorldRunnerCapabilitiesView
- type FactoryWorldRunnerOptionalCapability
- type FactoryWorldRunnerOptionalCapabilityStatus
- type FactoryWorldRunnerOptionalCapabilitySupportView
- type FactoryWorldScriptRequestView
- type FactoryWorldScriptResponseView
- type FactoryWorldSelectedRunnerView
- type FactoryWorldTokenView
- type FactoryWorldWorkDiagnostics
- type FactoryWorldWorkItemRef
- type FactoryWorldWorkItemRefLineageContinuity
- type FactoryWorldWorkItemRefLineageSourceKind
- type FactoryWorldWorkItemRefPayloadStatus
- type FactoryWorldWorkMoveOperationProjectionSlice
- type FactoryWorldWorkMoveOperationView
- type FactoryWorldWorkstationRequestCountView
- type FactoryWorldWorkstationRequestProjectionSlice
- type FactoryWorldWorkstationRequestRequestView
- type FactoryWorldWorkstationRequestResponseView
- type FactoryWorldWorkstationRequestView
- type GetProviderSessionDetailsParams
- type GorillaServerOptions
- type Guard
- type GuardMatchConfig
- type GuardType
- type HostedLinearWorkerClaim
- type HostedLinearWorkerConfig
- type HostedLinearWorkerMapping
- type HostedWorkerAuth
- type HostedWorkerProvider
- type HybridLogicalTimestamp
- type InferenceOutcome
- type InferenceRequestEventPayload
- type InferenceResponseEventPayload
- type InitialStructureRequestEventPayload
- type InputKind
- type InputType
- type IntegerMap
- type InternalError
- type InvalidParamFormatError
- type InvokeModelJSONRequestBody
- type ListFactorySessionsResponse
- type ListModelsResponse
- type ListWorkBySessionIdParams
- type ListWorkBySessionIdParamsSortBy
- type ListWorkParams
- type ListWorkParamsSortBy
- type ListWorkResponse
- type LoadableProviderSessionKind
- type LoadableProviderSessionProvider
- type LoadableProviderSessionRef
- type MaxResults
- type MiddlewareFunc
- type ModelCapability
- type ModelDetail
- type ModelInvocationOptions
- type ModelInvocationRequest
- type ModelInvocationResponse
- type ModelInvocationResponseMode
- type ModelLoadState
- type ModelOperation
- type ModelOperationContentType
- type ModelOperationName
- type ModelOperationSlot
- type ModelPullDownloadedFile
- type ModelPullOutcome
- type ModelPullResponse
- type ModelRequestEventPayload
- type ModelResourceSummary
- type ModelResponseEventPayload
- type ModelStatus
- type ModelSummary
- type MoveWorkBySessionIdJSONRequestBody
- type MoveWorkConflict
- type MoveWorkJSONRequestBody
- type MoveWorkRequest
- type NextToken
- type NotFound
- type OpenFactorySessionJSONRequestBody
- type OpenFactorySessionRequest
- type OpenFactorySessionResponse
- type PaginationContext
- type PanicDiagnostic
- type PromptTemplateContract
- type PromptTemplateDiagnostic
- type PromptTemplateDiagnosticKind
- type PromptTemplateUnavailableAccessPattern
- type PromptTemplateValidationRequest
- type PromptTemplateValidationResult
- type PromptTemplateVariableReference
- type PromptTemplateVariableReferenceCategory
- type ProviderDiagnostic
- type ProviderFailureMetadata
- type ProviderSessionDetailResponse
- type ProviderSessionFunctionCallSummary
- type ProviderSessionLineError
- type ProviderSessionMetadata
- type ProviderSessionParseSummary
- type ProviderSessionReasoningSummary
- type ProviderSessionSourceMetadata
- type ProviderSessionTokenUsage
- type ProviderSessionTranscriptEntry
- type ProviderSessionTranscriptEntryType
- type ProviderSessionTurnSummary
- type ProviderSessionUnknownEvent
- type Relation
- type RelationType
- type RelationshipChangeRequestEventPayload
- type RenderedPromptDiagnostic
- type RequiredHeaderError
- type RequiredParamError
- type RequiredTool
- type ResolvedModelOperationBinding
- type ResolvedModelOperationBindingSource
- type Resource
- type ResourceManifest
- type ResourceRequirement
- type ResourceType
- type ResourceUsage
- type RunRequestEventPayload
- type RunResponseEventPayload
- type RunnerID
- type RunnerSelectionSource
- type SafeWorkDiagnostics
- type SaveCurrentFactoryBadRequest
- type SaveCurrentFactoryBySessionIdJSONRequestBody
- type SaveCurrentFactoryConflict
- type SaveFactoryForSessionRequest
- type ScriptExecutionOutcome
- type ScriptFailureType
- type ScriptRequestEventPayload
- type ScriptResponseEventPayload
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) CloseFactorySession(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetCurrentFactoryBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetCurrentFactoryWorkstationPromptTemplateContractBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetEvents(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetEventsBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetModel(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProviderSessionDetails(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetStatus(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetStatusBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetWork(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetWorkBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) InvokeModel(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListFactorySessions(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListModels(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListWork(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListWorkBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) MoveWork(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) MoveWorkBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) OpenFactorySession(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PullModel(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) SaveCurrentFactoryBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) StageSubmitWorkFile(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) StageSubmitWorkFileBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) SubmitWork(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) SubmitWorkBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) UpsertWorkRequest(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) UpsertWorkRequestBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ValidateCurrentFactoryWorkstationPromptTemplateBySessionId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ValidateFactory(w http.ResponseWriter, r *http.Request)
- type SessionID
- type SortBy
- type StageSubmitWorkFileBySessionIdJSONRequestBody
- type StageSubmitWorkFileJSONRequestBody
- type StageSubmitWorkFileRequest
- type StageSubmitWorkFileResponse
- type StateName
- type StateType
- type StatusCategories
- type StatusResponse
- type StringMap
- type SubmitRelation
- type SubmitWorkAudioItem
- type SubmitWorkBySessionIdJSONRequestBody
- type SubmitWorkContentURLProperty
- type SubmitWorkDocumentItem
- type SubmitWorkFileItemCommonFields
- type SubmitWorkImageItem
- type SubmitWorkItem
- func (t SubmitWorkItem) AsSubmitWorkAudioItem() (SubmitWorkAudioItem, error)
- func (t SubmitWorkItem) AsSubmitWorkDocumentItem() (SubmitWorkDocumentItem, error)
- func (t SubmitWorkItem) AsSubmitWorkImageItem() (SubmitWorkImageItem, error)
- func (t SubmitWorkItem) AsSubmitWorkTextItem() (SubmitWorkTextItem, error)
- func (t SubmitWorkItem) AsSubmitWorkVideoItem() (SubmitWorkVideoItem, error)
- func (t *SubmitWorkItem) FromSubmitWorkAudioItem(v SubmitWorkAudioItem) error
- func (t *SubmitWorkItem) FromSubmitWorkDocumentItem(v SubmitWorkDocumentItem) error
- func (t *SubmitWorkItem) FromSubmitWorkImageItem(v SubmitWorkImageItem) error
- func (t *SubmitWorkItem) FromSubmitWorkTextItem(v SubmitWorkTextItem) error
- func (t *SubmitWorkItem) FromSubmitWorkVideoItem(v SubmitWorkVideoItem) error
- func (t SubmitWorkItem) MarshalJSON() ([]byte, error)
- func (t *SubmitWorkItem) MergeSubmitWorkAudioItem(v SubmitWorkAudioItem) error
- func (t *SubmitWorkItem) MergeSubmitWorkDocumentItem(v SubmitWorkDocumentItem) error
- func (t *SubmitWorkItem) MergeSubmitWorkImageItem(v SubmitWorkImageItem) error
- func (t *SubmitWorkItem) MergeSubmitWorkTextItem(v SubmitWorkTextItem) error
- func (t *SubmitWorkItem) MergeSubmitWorkVideoItem(v SubmitWorkVideoItem) error
- func (t *SubmitWorkItem) UnmarshalJSON(b []byte) error
- type SubmitWorkItemList
- type SubmitWorkItemType
- type SubmitWorkJSONRequestBody
- type SubmitWorkRequest
- type SubmitWorkResponse
- type SubmitWorkTextItem
- type SubmitWorkVideoItem
- type TokenHistory
- type TokenResponse
- type TooManyValuesForParamError
- type Transition
- type UnescapedCookieParamError
- type UnmarshalingParamError
- type UpsertWorkRequestBySessionIdJSONRequestBody
- type UpsertWorkRequestJSONRequestBody
- type UpsertWorkRequestResponse
- type UpsertWorkRequestSubmittedWork
- type ValidateCurrentFactoryWorkstationPromptTemplateBySessionIdJSONRequestBody
- type ValidateFactoryJSONRequestBody
- type WallClock
- type Work
- type WorkAudioContentPart
- type WorkBinaryContentPart
- type WorkContent
- type WorkContentCommonFields
- type WorkContentDeprecatedFileProperty
- type WorkContentMetadata
- type WorkContentPart
- func (t WorkContentPart) AsWorkAudioContentPart() (WorkAudioContentPart, error)
- func (t WorkContentPart) AsWorkBinaryContentPart() (WorkBinaryContentPart, error)
- func (t WorkContentPart) AsWorkImageContentPart() (WorkImageContentPart, error)
- func (t WorkContentPart) AsWorkJsonContentPart() (WorkJsonContentPart, error)
- func (t WorkContentPart) AsWorkTextContentPart() (WorkTextContentPart, error)
- func (t *WorkContentPart) FromWorkAudioContentPart(v WorkAudioContentPart) error
- func (t *WorkContentPart) FromWorkBinaryContentPart(v WorkBinaryContentPart) error
- func (t *WorkContentPart) FromWorkImageContentPart(v WorkImageContentPart) error
- func (t *WorkContentPart) FromWorkJsonContentPart(v WorkJsonContentPart) error
- func (t *WorkContentPart) FromWorkTextContentPart(v WorkTextContentPart) error
- func (t WorkContentPart) MarshalJSON() ([]byte, error)
- func (t *WorkContentPart) MergeWorkAudioContentPart(v WorkAudioContentPart) error
- func (t *WorkContentPart) MergeWorkBinaryContentPart(v WorkBinaryContentPart) error
- func (t *WorkContentPart) MergeWorkImageContentPart(v WorkImageContentPart) error
- func (t *WorkContentPart) MergeWorkJsonContentPart(v WorkJsonContentPart) error
- func (t *WorkContentPart) MergeWorkTextContentPart(v WorkTextContentPart) error
- func (t *WorkContentPart) UnmarshalJSON(b []byte) error
- type WorkContentPartType
- type WorkContentURLProperty
- type WorkDiagnostics
- type WorkFailureFamily
- type WorkFailureType
- type WorkImageContentPart
- type WorkJsonContentPart
- type WorkListName
- type WorkListTraceId
- type WorkListWorkTypeName
- type WorkMetrics
- type WorkOrTokenID
- type WorkOutcome
- type WorkRequest
- type WorkRequestEventPayload
- type WorkRequestType
- type WorkState
- type WorkStateChangeEventPayload
- type WorkStateChangeSource
- type WorkStateType
- type WorkTextContentPart
- type WorkType
- type WorkTypeHandlingBehavior
- type Worker
- type WorkerModelLocality
- type WorkerModelProvider
- type WorkerProvider
- type WorkerType
- type Workstation
- type WorkstationCron
- type WorkstationIO
- type WorkstationKind
- type WorkstationLimits
- type WorkstationOperationBinding
- type WorkstationOperationBindingSelector
- type WorkstationType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r *mux.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options GorillaServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type BundledFile ¶
type BundledFile struct {
// Content Inline content payload for a portable bundled file.
Content BundledFileContent `json:"content"`
// TargetPath Canonical factory-relative restoration target for the bundled file. Absolute paths, backslash-separated paths, and paths that require dot-segment normalization are rejected.
TargetPath string `json:"targetPath"`
// Type Portable file class. SCRIPT entries target factory/scripts/..., DOC entries target factory/docs/..., INPUT entries target factory/inputs/<work-type>/<channel>/..., and ROOT_HELPER entries target supported project-root helper files such as Makefile. Shared-factory INPUT entries snapshot current source inputs at share time instead of creating a live link.
Type BundledFileType `json:"type"`
}
BundledFile One explicit portable bundled file entry carried by the factory portability manifest. SCRIPT files target factory/scripts/..., DOC files target factory/docs/..., INPUT files target factory/inputs/<work-type>/<channel>/..., and ROOT_HELPER files target supported project-root helper paths such as Makefile. In v1 shared-factory exports, INPUT entries encode a share-time snapshot of starter work that is copied into the recipient factory as detached seeded work.
type BundledFileContent ¶
type BundledFileContent struct {
// Encoding Declared content encoding for the inline payload. V1 bundled files use UTF-8 text content.
Encoding BundledFileContentEncoding `json:"encoding"`
// Inline Inline bundled file content carried in the manifest. Files under factory/scripts/, factory/docs/, and supported root helper paths are only bundled when they appear in bundledFiles.
Inline string `json:"inline"`
}
BundledFileContent Inline content payload for a portable bundled file.
type BundledFileContentEncoding ¶
type BundledFileContentEncoding string
BundledFileContentEncoding Declared content encoding for the inline payload. V1 bundled files use UTF-8 text content.
const (
Utf8 BundledFileContentEncoding = "utf-8"
)
Defines values for BundledFileContentEncoding.
type BundledFileType ¶
type BundledFileType string
BundledFileType Portable file class. SCRIPT entries target factory/scripts/..., DOC entries target factory/docs/..., INPUT entries target factory/inputs/<work-type>/<channel>/..., and ROOT_HELPER entries target supported project-root helper files such as Makefile. Shared-factory INPUT entries snapshot current source inputs at share time instead of creating a live link.
const ( BundledFileTypeDOC BundledFileType = "DOC" BundledFileTypeINPUT BundledFileType = "INPUT" BundledFileTypeROOTHELPER BundledFileType = "ROOT_HELPER" BundledFileTypeSCRIPT BundledFileType = "SCRIPT" )
Defines values for BundledFileType.
type ClassificationRoute ¶ added in v0.0.5
type ClassificationRoute struct {
// Label Case-sensitive classifier label that must match the trimmed classifier output exactly.
Label string `json:"label"`
// Outputs One or more authored destinations emitted when this classifier label is selected.
Outputs []WorkstationIO `json:"outputs"`
}
ClassificationRoute defines model for ClassificationRoute.
type CommandDiagnostic ¶
type CommandDiagnostic struct {
Args *[]string `json:"args,omitempty"`
Command *string `json:"command,omitempty"`
DurationNanos *int64 `json:"durationNanos,omitempty"`
Env *StringMap `json:"env,omitempty"`
ExitCode *int `json:"exitCode,omitempty"`
Stderr *string `json:"stderr,omitempty"`
Stdin *string `json:"stdin,omitempty"`
Stdout *string `json:"stdout,omitempty"`
TimedOut *bool `json:"timedOut,omitempty"`
WorkingDir *string `json:"workingDir,omitempty"`
}
CommandDiagnostic defines model for CommandDiagnostic.
type CreateFactoryBadRequest ¶
type CreateFactoryBadRequest = ErrorResponse
CreateFactoryBadRequest defines model for CreateFactoryBadRequest.
type CreateFactoryConflict ¶
type CreateFactoryConflict = ErrorResponse
CreateFactoryConflict defines model for CreateFactoryConflict.
type CurrentFactoryNotFound ¶
type CurrentFactoryNotFound = ErrorResponse
CurrentFactoryNotFound defines model for CurrentFactoryNotFound.
type Diagnostics ¶
type Diagnostics struct {
Notes *[]string `json:"notes,omitempty"`
Workers *map[string]SafeWorkDiagnostics `json:"workers,omitempty"`
}
Diagnostics defines model for Diagnostics.
type DispatchConsumedWorkRef ¶
type DispatchConsumedWorkRef struct {
// WorkId Canonical work identity for one consumed dispatch input.
WorkId string `json:"workId"`
}
DispatchConsumedWorkRef Ordered reference to one consumed work item on a dispatch boundary. Dispatch-request payloads keep only the consumed work identity here; work type, trace, display, and other work facts must be derived from prior WORK_REQUEST events plus FactoryEvent.context.
type DispatchRequestEventMetadata ¶
type DispatchRequestEventMetadata struct {
// ReplayKey Stable replay correlation key for recorded dispatch reconstruction.
ReplayKey *string `json:"replayKey,omitempty"`
// RunnerId Stable built-in runner identifiers supported by factory and workstation runner selection.
RunnerId *RunnerID `json:"runnerId,omitempty"`
// RunnerSelectionSource Configuration layer that supplied the resolved built-in runner selection for a dispatch.
RunnerSelectionSource *RunnerSelectionSource `json:"runnerSelectionSource,omitempty"`
}
DispatchRequestEventMetadata Optional non-identity dispatch metadata retained on dispatch-request events. Request, trace, work, and dispatch identity must remain on FactoryEvent.context rather than reappearing here.
type DispatchRequestEventPayload ¶
type DispatchRequestEventPayload struct {
// CurrentChainingTraceId Deprecated compatibility copy of the dispatch chaining-trace identifier; prefer FactoryEvent.context.currentChainingTraceId.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
Inputs []DispatchConsumedWorkRef `json:"inputs"`
// Metadata Optional non-identity dispatch metadata retained on dispatch-request events. Request, trace, work, and dispatch identity must remain on FactoryEvent.context rather than reappearing here.
Metadata *DispatchRequestEventMetadata `json:"metadata,omitempty"`
// PreviousChainingTraceIds Deprecated compatibility copy of predecessor chaining traces; prefer FactoryEvent.context.previousChainingTraceIds.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
Resources *[]Resource `json:"resources,omitempty"`
TransitionId string `json:"transitionId"`
}
DispatchRequestEventPayload Customer-visible dispatch start event. FactoryEvent.context owns dispatch, request, trace, and work identity. This payload keeps only non-derived dispatch facts first known when execution starts; workstation and worker topology must be reconstructed from the initial structure and the retained transition identifier. Ordered inputs carry consumed work references only; work type, trace, display, and other work facts must be rebuilt from prior work-request history.
type DispatchResponseEventPayload ¶
type DispatchResponseEventPayload struct {
CompletionId *string `json:"completionId,omitempty"`
// CurrentChainingTraceId Deprecated compatibility copy of the dispatch chaining-trace identifier; prefer FactoryEvent.context.currentChainingTraceId.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
DurationMillis *int64 `json:"durationMillis,omitempty"`
Error *string `json:"error,omitempty"`
FailureMessage *string `json:"failureMessage,omitempty"`
FailureReason *string `json:"failureReason,omitempty"`
Feedback *string `json:"feedback,omitempty"`
Metadata *StringMap `json:"metadata,omitempty"`
Metrics *WorkMetrics `json:"metrics,omitempty"`
// Outcome Result category returned by a workstation execution.
Outcome WorkOutcome `json:"outcome"`
Output *string `json:"output,omitempty"`
OutputResources *[]Resource `json:"outputResources,omitempty"`
OutputWork *[]Work `json:"outputWork,omitempty"`
// PreviousChainingTraceIds Deprecated compatibility copy of predecessor chaining traces; prefer FactoryEvent.context.previousChainingTraceIds.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
ProviderFailure *ProviderFailureMetadata `json:"providerFailure,omitempty"`
SelectedClassificationLabel *string `json:"selectedClassificationLabel,omitempty"`
TransitionId string `json:"transitionId"`
}
DispatchResponseEventPayload Customer-visible dispatch completion event. Output work is represented with the same Work schema used by request submission rather than token or marking-mutation internals. FactoryEvent.context owns dispatch, trace, and work identity; workstation and worker topology must be derived from the matching dispatch-request event plus the initial structure. Provider-attempt session and safe diagnostic facts stay on inference response events instead of being copied onto dispatch completion payloads.
type ErrorFamily ¶
type ErrorFamily string
ErrorFamily Stable machine-readable error family for broader client grouping.
const ( ErrorFamilyBadRequest ErrorFamily = "BAD_REQUEST" ErrorFamilyConflict ErrorFamily = "CONFLICT" ErrorFamilyInternalServerError ErrorFamily = "INTERNAL_SERVER_ERROR" ErrorFamilyNotFound ErrorFamily = "NOT_FOUND" )
Defines values for ErrorFamily.
type ErrorResponse ¶
type ErrorResponse struct {
// Code Stable machine-readable error code.
Code ErrorResponseCode `json:"code"`
// Family Stable machine-readable error family for broader client grouping.
Family ErrorFamily `json:"family"`
Message string `json:"message"`
// Targets Optional canonical validation targets that clients can map to factory graph nodes, handles, and form fields.
Targets *[]FactoryValidationTarget `json:"targets,omitempty"`
}
ErrorResponse defines model for ErrorResponse.
type ErrorResponseCode ¶
type ErrorResponseCode string
ErrorResponseCode Stable machine-readable error code.
const ( BADREQUEST ErrorResponseCode = "BAD_REQUEST" FACTORYALREADYEXISTS ErrorResponseCode = "FACTORY_ALREADY_EXISTS" FACTORYNOTIDLE ErrorResponseCode = "FACTORY_NOT_IDLE" INTERNALERROR ErrorResponseCode = "INTERNAL_ERROR" INVALIDFACTORY ErrorResponseCode = "INVALID_FACTORY" INVALIDFACTORYNAME ErrorResponseCode = "INVALID_FACTORY_NAME" MOVEWORKREQUESTALREADYAPPLIED ErrorResponseCode = "MOVE_WORK_REQUEST_ALREADY_APPLIED" NOTFOUND ErrorResponseCode = "NOT_FOUND" STALEFACTORYVERSION ErrorResponseCode = "STALE_FACTORY_VERSION" )
Defines values for ErrorResponseCode.
type ErrorTarget ¶ added in v0.0.5
type ErrorTarget struct {
// Field Optional request or form field path associated with the error.
Field *string `json:"field,omitempty"`
// Id Optional graph entity, relationship, or save condition identifier.
Id *string `json:"id,omitempty"`
// Kind Client-visible target category such as form, node, edge, field, or save.
Kind string `json:"kind"`
}
ErrorTarget defines model for ErrorTarget.
type Factory ¶
type Factory struct {
// FactoryDirectory Directory that contained the factory.json used for this serialized runtime config.
FactoryDirectory *string `json:"factoryDirectory,omitempty"`
// Guards Root-level guards that apply across the factory instead of one specific workstation or input.
Guards *[]FactoryGuard `json:"guards,omitempty"`
// Id Factory identifier used as the factory-level template context fallback.
Id *string `json:"id,omitempty"`
// InputTypes Named input kinds accepted by the factory. The default input type is implicit and must not be declared.
InputTypes *[]InputType `json:"inputTypes,omitempty"`
Metadata *StringMap `json:"metadata,omitempty"`
// Name Customer-facing identifier for one stored named factory. `GET /factory-sessions/~default/factory` may also return the reserved `UNDEFINED` identifier when the active runtime is still the default root factory and no durable current-factory pointer exists. Semantic validation failures return `INVALID_FACTORY_NAME`, including attempts to activate a named factory with the reserved identifier.
Name FactoryName `json:"name"`
// Resources Shared capacity pools that workers or workstations can consume while work is executing.
Resources *[]Resource `json:"resources,omitempty"`
// Runner Stable built-in runner identifiers supported by factory and workstation runner selection.
Runner *RunnerID `json:"runner,omitempty"`
// SourceDirectory Original source directory for record/replay and drift diagnostics.
SourceDirectory *string `json:"sourceDirectory,omitempty"`
// SupportingFiles Canonical portability manifest for Agent Factory bundles. Required tools are validation-only PATH dependencies; bundled files carry portable content for restoration inside the factory boundary.
SupportingFiles *ResourceManifest `json:"supportingFiles,omitempty"`
Version *HybridLogicalTimestamp `json:"version,omitempty"`
// WorkTypes Customer-authored work item categories and the lifecycle states each one can occupy.
WorkTypes *[]WorkType `json:"workTypes,omitempty"`
// Workers Reusable worker definitions that workstations reference by name when dispatching work.
Workers *[]Worker `json:"workers,omitempty"`
// Workstations Processing steps that consume work, invoke workers, and emit the next work states.
Workstations *[]Workstation `json:"workstations,omitempty"`
}
Factory Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.
type FactoryChangeEventPayload ¶ added in v0.0.5
type FactoryChangeEventPayload struct {
// Factory Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.
Factory Factory `json:"factory"`
Metadata *StringMap `json:"metadata,omitempty"`
SourceDirectory *string `json:"sourceDirectory,omitempty"`
}
FactoryChangeEventPayload Runtime topology snapshot after a live factory definition change replaces the running factory.
type FactoryEvent ¶
type FactoryEvent struct {
Context FactoryEventContext `json:"context"`
// Id Stable event identifier. Record/replay artifacts must preserve this value.
Id string `json:"id"`
Payload FactoryEvent_Payload `json:"payload"`
// SchemaVersion Version of the factory event envelope schema.
SchemaVersion FactoryEventSchemaVersion `json:"schemaVersion"`
// Type Canonical event vocabulary for customer-visible runtime changes. Work entering the factory is represented as WORK_REQUEST, including single-work submissions that are normalized into one-work requests.
Type FactoryEventType `json:"type"`
}
FactoryEvent Versioned Agent Factory event message. This is the intended canonical schema for customer event streams, history projection, record/replay artifacts, and runtime diagnostics. New fields use camelCase even when older REST resource schemas still contain legacy snake_case fields.
type FactoryEventContext ¶
type FactoryEventContext struct {
// CurrentChainingTraceId Canonical chaining-trace identifier for the dispatch currently represented by this event context.
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
// DispatchId Canonical dispatch identity for dispatch and inference events; payloads must not restate it.
DispatchId *string `json:"dispatchId,omitempty"`
// EventTime Wall-clock event timestamp for customer explanation and diagnostics. ISO8601 timestamp.
EventTime time.Time `json:"eventTime"`
// PreviousChainingTraceIds Canonical predecessor chaining traces consumed by the dispatch in deterministic order.
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
// RequestId Canonical request identity for all request-scoped events; payload metadata must not restate it.
RequestId *string `json:"requestId,omitempty"`
// Sequence Append-only event-log sequence number.
Sequence int `json:"sequence"`
// Source Human-readable source such as api, filewatcher, replay, cron, or worker.
Source *string `json:"source,omitempty"`
// Tick Logical engine tick observed by the runtime.
Tick int `json:"tick"`
// TraceIds Canonical trace identifiers that contributed to this event; payloads must not restate them.
TraceIds *[]string `json:"traceIds,omitempty"`
// WorkIds Canonical work identities correlated to this event; payloads must not restate them.
WorkIds *[]string `json:"workIds,omitempty"`
}
FactoryEventContext defines model for FactoryEventContext.
type FactoryEventSchemaVersion ¶
type FactoryEventSchemaVersion string
FactoryEventSchemaVersion Version of the factory event envelope schema.
const (
AgentFactoryEventV1 FactoryEventSchemaVersion = "agent-factory.event.v1"
)
Defines values for FactoryEventSchemaVersion.
type FactoryEventType ¶
type FactoryEventType string
FactoryEventType Canonical event vocabulary for customer-visible runtime changes. Work entering the factory is represented as WORK_REQUEST, including single-work submissions that are normalized into one-work requests.
const ( FactoryEventTypeDispatchRequest FactoryEventType = "DISPATCH_REQUEST" FactoryEventTypeDispatchResponse FactoryEventType = "DISPATCH_RESPONSE" FactoryEventTypeFactoryChange FactoryEventType = "FACTORY_CHANGE" FactoryEventTypeFactoryStateResponse FactoryEventType = "FACTORY_STATE_RESPONSE" FactoryEventTypeInferenceRequest FactoryEventType = "INFERENCE_REQUEST" FactoryEventTypeInferenceResponse FactoryEventType = "INFERENCE_RESPONSE" FactoryEventTypeInitialStructureRequest FactoryEventType = "INITIAL_STRUCTURE_REQUEST" FactoryEventTypeModelRequest FactoryEventType = "MODEL_REQUEST" FactoryEventTypeModelResponse FactoryEventType = "MODEL_RESPONSE" FactoryEventTypeRelationshipChangeRequest FactoryEventType = "RELATIONSHIP_CHANGE_REQUEST" FactoryEventTypeRunRequest FactoryEventType = "RUN_REQUEST" FactoryEventTypeRunResponse FactoryEventType = "RUN_RESPONSE" FactoryEventTypeScriptRequest FactoryEventType = "SCRIPT_REQUEST" FactoryEventTypeScriptResponse FactoryEventType = "SCRIPT_RESPONSE" FactoryEventTypeWorkRequest FactoryEventType = "WORK_REQUEST" FactoryEventTypeWorkStateChange FactoryEventType = "WORK_STATE_CHANGE" )
Defines values for FactoryEventType.
type FactoryEvent_Payload ¶
type FactoryEvent_Payload struct {
// contains filtered or unexported fields
}
FactoryEvent_Payload defines model for FactoryEvent.Payload.
func (FactoryEvent_Payload) AsDispatchRequestEventPayload ¶
func (t FactoryEvent_Payload) AsDispatchRequestEventPayload() (DispatchRequestEventPayload, error)
AsDispatchRequestEventPayload returns the union data inside the FactoryEvent_Payload as a DispatchRequestEventPayload
func (FactoryEvent_Payload) AsDispatchResponseEventPayload ¶
func (t FactoryEvent_Payload) AsDispatchResponseEventPayload() (DispatchResponseEventPayload, error)
AsDispatchResponseEventPayload returns the union data inside the FactoryEvent_Payload as a DispatchResponseEventPayload
func (FactoryEvent_Payload) AsFactoryChangeEventPayload ¶ added in v0.0.5
func (t FactoryEvent_Payload) AsFactoryChangeEventPayload() (FactoryChangeEventPayload, error)
AsFactoryChangeEventPayload returns the union data inside the FactoryEvent_Payload as a FactoryChangeEventPayload
func (FactoryEvent_Payload) AsFactoryStateResponseEventPayload ¶
func (t FactoryEvent_Payload) AsFactoryStateResponseEventPayload() (FactoryStateResponseEventPayload, error)
AsFactoryStateResponseEventPayload returns the union data inside the FactoryEvent_Payload as a FactoryStateResponseEventPayload
func (FactoryEvent_Payload) AsInferenceRequestEventPayload ¶
func (t FactoryEvent_Payload) AsInferenceRequestEventPayload() (InferenceRequestEventPayload, error)
AsInferenceRequestEventPayload returns the union data inside the FactoryEvent_Payload as a InferenceRequestEventPayload
func (FactoryEvent_Payload) AsInferenceResponseEventPayload ¶
func (t FactoryEvent_Payload) AsInferenceResponseEventPayload() (InferenceResponseEventPayload, error)
AsInferenceResponseEventPayload returns the union data inside the FactoryEvent_Payload as a InferenceResponseEventPayload
func (FactoryEvent_Payload) AsInitialStructureRequestEventPayload ¶
func (t FactoryEvent_Payload) AsInitialStructureRequestEventPayload() (InitialStructureRequestEventPayload, error)
AsInitialStructureRequestEventPayload returns the union data inside the FactoryEvent_Payload as a InitialStructureRequestEventPayload
func (FactoryEvent_Payload) AsModelRequestEventPayload ¶ added in v0.0.5
func (t FactoryEvent_Payload) AsModelRequestEventPayload() (ModelRequestEventPayload, error)
AsModelRequestEventPayload returns the union data inside the FactoryEvent_Payload as a ModelRequestEventPayload
func (FactoryEvent_Payload) AsModelResponseEventPayload ¶ added in v0.0.5
func (t FactoryEvent_Payload) AsModelResponseEventPayload() (ModelResponseEventPayload, error)
AsModelResponseEventPayload returns the union data inside the FactoryEvent_Payload as a ModelResponseEventPayload
func (FactoryEvent_Payload) AsRelationshipChangeRequestEventPayload ¶
func (t FactoryEvent_Payload) AsRelationshipChangeRequestEventPayload() (RelationshipChangeRequestEventPayload, error)
AsRelationshipChangeRequestEventPayload returns the union data inside the FactoryEvent_Payload as a RelationshipChangeRequestEventPayload
func (FactoryEvent_Payload) AsRunRequestEventPayload ¶
func (t FactoryEvent_Payload) AsRunRequestEventPayload() (RunRequestEventPayload, error)
AsRunRequestEventPayload returns the union data inside the FactoryEvent_Payload as a RunRequestEventPayload
func (FactoryEvent_Payload) AsRunResponseEventPayload ¶
func (t FactoryEvent_Payload) AsRunResponseEventPayload() (RunResponseEventPayload, error)
AsRunResponseEventPayload returns the union data inside the FactoryEvent_Payload as a RunResponseEventPayload
func (FactoryEvent_Payload) AsScriptRequestEventPayload ¶
func (t FactoryEvent_Payload) AsScriptRequestEventPayload() (ScriptRequestEventPayload, error)
AsScriptRequestEventPayload returns the union data inside the FactoryEvent_Payload as a ScriptRequestEventPayload
func (FactoryEvent_Payload) AsScriptResponseEventPayload ¶
func (t FactoryEvent_Payload) AsScriptResponseEventPayload() (ScriptResponseEventPayload, error)
AsScriptResponseEventPayload returns the union data inside the FactoryEvent_Payload as a ScriptResponseEventPayload
func (FactoryEvent_Payload) AsWorkRequestEventPayload ¶
func (t FactoryEvent_Payload) AsWorkRequestEventPayload() (WorkRequestEventPayload, error)
AsWorkRequestEventPayload returns the union data inside the FactoryEvent_Payload as a WorkRequestEventPayload
func (FactoryEvent_Payload) AsWorkStateChangeEventPayload ¶ added in v0.0.5
func (t FactoryEvent_Payload) AsWorkStateChangeEventPayload() (WorkStateChangeEventPayload, error)
AsWorkStateChangeEventPayload returns the union data inside the FactoryEvent_Payload as a WorkStateChangeEventPayload
func (*FactoryEvent_Payload) FromDispatchRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromDispatchRequestEventPayload(v DispatchRequestEventPayload) error
FromDispatchRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided DispatchRequestEventPayload
func (*FactoryEvent_Payload) FromDispatchResponseEventPayload ¶
func (t *FactoryEvent_Payload) FromDispatchResponseEventPayload(v DispatchResponseEventPayload) error
FromDispatchResponseEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided DispatchResponseEventPayload
func (*FactoryEvent_Payload) FromFactoryChangeEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) FromFactoryChangeEventPayload(v FactoryChangeEventPayload) error
FromFactoryChangeEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided FactoryChangeEventPayload
func (*FactoryEvent_Payload) FromFactoryStateResponseEventPayload ¶
func (t *FactoryEvent_Payload) FromFactoryStateResponseEventPayload(v FactoryStateResponseEventPayload) error
FromFactoryStateResponseEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided FactoryStateResponseEventPayload
func (*FactoryEvent_Payload) FromInferenceRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromInferenceRequestEventPayload(v InferenceRequestEventPayload) error
FromInferenceRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided InferenceRequestEventPayload
func (*FactoryEvent_Payload) FromInferenceResponseEventPayload ¶
func (t *FactoryEvent_Payload) FromInferenceResponseEventPayload(v InferenceResponseEventPayload) error
FromInferenceResponseEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided InferenceResponseEventPayload
func (*FactoryEvent_Payload) FromInitialStructureRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromInitialStructureRequestEventPayload(v InitialStructureRequestEventPayload) error
FromInitialStructureRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided InitialStructureRequestEventPayload
func (*FactoryEvent_Payload) FromModelRequestEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) FromModelRequestEventPayload(v ModelRequestEventPayload) error
FromModelRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided ModelRequestEventPayload
func (*FactoryEvent_Payload) FromModelResponseEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) FromModelResponseEventPayload(v ModelResponseEventPayload) error
FromModelResponseEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided ModelResponseEventPayload
func (*FactoryEvent_Payload) FromRelationshipChangeRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromRelationshipChangeRequestEventPayload(v RelationshipChangeRequestEventPayload) error
FromRelationshipChangeRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided RelationshipChangeRequestEventPayload
func (*FactoryEvent_Payload) FromRunRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromRunRequestEventPayload(v RunRequestEventPayload) error
FromRunRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided RunRequestEventPayload
func (*FactoryEvent_Payload) FromRunResponseEventPayload ¶
func (t *FactoryEvent_Payload) FromRunResponseEventPayload(v RunResponseEventPayload) error
FromRunResponseEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided RunResponseEventPayload
func (*FactoryEvent_Payload) FromScriptRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromScriptRequestEventPayload(v ScriptRequestEventPayload) error
FromScriptRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided ScriptRequestEventPayload
func (*FactoryEvent_Payload) FromScriptResponseEventPayload ¶
func (t *FactoryEvent_Payload) FromScriptResponseEventPayload(v ScriptResponseEventPayload) error
FromScriptResponseEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided ScriptResponseEventPayload
func (*FactoryEvent_Payload) FromWorkRequestEventPayload ¶
func (t *FactoryEvent_Payload) FromWorkRequestEventPayload(v WorkRequestEventPayload) error
FromWorkRequestEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided WorkRequestEventPayload
func (*FactoryEvent_Payload) FromWorkStateChangeEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) FromWorkStateChangeEventPayload(v WorkStateChangeEventPayload) error
FromWorkStateChangeEventPayload overwrites any union data inside the FactoryEvent_Payload as the provided WorkStateChangeEventPayload
func (FactoryEvent_Payload) MarshalJSON ¶
func (t FactoryEvent_Payload) MarshalJSON() ([]byte, error)
func (*FactoryEvent_Payload) MergeDispatchRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeDispatchRequestEventPayload(v DispatchRequestEventPayload) error
MergeDispatchRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided DispatchRequestEventPayload
func (*FactoryEvent_Payload) MergeDispatchResponseEventPayload ¶
func (t *FactoryEvent_Payload) MergeDispatchResponseEventPayload(v DispatchResponseEventPayload) error
MergeDispatchResponseEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided DispatchResponseEventPayload
func (*FactoryEvent_Payload) MergeFactoryChangeEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) MergeFactoryChangeEventPayload(v FactoryChangeEventPayload) error
MergeFactoryChangeEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided FactoryChangeEventPayload
func (*FactoryEvent_Payload) MergeFactoryStateResponseEventPayload ¶
func (t *FactoryEvent_Payload) MergeFactoryStateResponseEventPayload(v FactoryStateResponseEventPayload) error
MergeFactoryStateResponseEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided FactoryStateResponseEventPayload
func (*FactoryEvent_Payload) MergeInferenceRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeInferenceRequestEventPayload(v InferenceRequestEventPayload) error
MergeInferenceRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided InferenceRequestEventPayload
func (*FactoryEvent_Payload) MergeInferenceResponseEventPayload ¶
func (t *FactoryEvent_Payload) MergeInferenceResponseEventPayload(v InferenceResponseEventPayload) error
MergeInferenceResponseEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided InferenceResponseEventPayload
func (*FactoryEvent_Payload) MergeInitialStructureRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeInitialStructureRequestEventPayload(v InitialStructureRequestEventPayload) error
MergeInitialStructureRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided InitialStructureRequestEventPayload
func (*FactoryEvent_Payload) MergeModelRequestEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) MergeModelRequestEventPayload(v ModelRequestEventPayload) error
MergeModelRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided ModelRequestEventPayload
func (*FactoryEvent_Payload) MergeModelResponseEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) MergeModelResponseEventPayload(v ModelResponseEventPayload) error
MergeModelResponseEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided ModelResponseEventPayload
func (*FactoryEvent_Payload) MergeRelationshipChangeRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeRelationshipChangeRequestEventPayload(v RelationshipChangeRequestEventPayload) error
MergeRelationshipChangeRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided RelationshipChangeRequestEventPayload
func (*FactoryEvent_Payload) MergeRunRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeRunRequestEventPayload(v RunRequestEventPayload) error
MergeRunRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided RunRequestEventPayload
func (*FactoryEvent_Payload) MergeRunResponseEventPayload ¶
func (t *FactoryEvent_Payload) MergeRunResponseEventPayload(v RunResponseEventPayload) error
MergeRunResponseEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided RunResponseEventPayload
func (*FactoryEvent_Payload) MergeScriptRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeScriptRequestEventPayload(v ScriptRequestEventPayload) error
MergeScriptRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided ScriptRequestEventPayload
func (*FactoryEvent_Payload) MergeScriptResponseEventPayload ¶
func (t *FactoryEvent_Payload) MergeScriptResponseEventPayload(v ScriptResponseEventPayload) error
MergeScriptResponseEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided ScriptResponseEventPayload
func (*FactoryEvent_Payload) MergeWorkRequestEventPayload ¶
func (t *FactoryEvent_Payload) MergeWorkRequestEventPayload(v WorkRequestEventPayload) error
MergeWorkRequestEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided WorkRequestEventPayload
func (*FactoryEvent_Payload) MergeWorkStateChangeEventPayload ¶ added in v0.0.5
func (t *FactoryEvent_Payload) MergeWorkStateChangeEventPayload(v WorkStateChangeEventPayload) error
MergeWorkStateChangeEventPayload performs a merge with any union data inside the FactoryEvent_Payload, using the provided WorkStateChangeEventPayload
func (*FactoryEvent_Payload) UnmarshalJSON ¶
func (t *FactoryEvent_Payload) UnmarshalJSON(b []byte) error
type FactoryGuard ¶
type FactoryGuard struct {
// Model Optional model name to scope throttling more narrowly than the provider-level window.
Model *string `json:"model,omitempty"`
// ModelProvider Provider whose inference-throttle history controls this factory-level guard.
ModelProvider WorkerModelProvider `json:"modelProvider"`
// RefreshWindow Duration string that controls how long the factory should keep re-checking throttle history before allowing the lane again.
RefreshWindow string `json:"refreshWindow"`
// Type Factory-level guard condition to evaluate before dispatch-ready transitions can proceed.
Type GuardType `json:"type"`
}
FactoryGuard Factory-level guard attached at the root factory definition.
type FactoryName ¶
type FactoryName = string
FactoryName Customer-facing identifier for one stored named factory. `GET /factory-sessions/~default/factory` may also return the reserved `UNDEFINED` identifier when the active runtime is still the default root factory and no durable current-factory pointer exists. Semantic validation failures return `INVALID_FACTORY_NAME`, including attempts to activate a named factory with the reserved identifier.
type FactorySaveMode ¶ added in v0.0.5
type FactorySaveMode string
FactorySaveMode Explicit save mode for session-scoped factory submission. Omitted mode on PUT /factory-sessions/{session_id}/factory defaults to REPLACE_CURRENT.
const ( FactorySaveModeReplaceCurrent FactorySaveMode = "REPLACE_CURRENT" FactorySaveModeUpsertNamedAndActivate FactorySaveMode = "UPSERT_NAMED_AND_ACTIVATE" )
Defines values for FactorySaveMode.
type FactorySessionSummary ¶ added in v0.0.5
type FactorySessionSummary struct {
FactoryDir string `json:"factoryDir"`
FolderPath string `json:"folderPath"`
Id string `json:"id"`
IsDefault bool `json:"isDefault"`
Project string `json:"project"`
Target FactorySessionTargetRef `json:"target"`
}
FactorySessionSummary defines model for FactorySessionSummary.
type FactorySessionTarget ¶ added in v0.0.5
type FactorySessionTarget struct {
FactoryDir string `json:"factoryDir"`
FolderPath string `json:"folderPath"`
Label string `json:"label"`
Project string `json:"project"`
Ref FactorySessionTargetRef `json:"ref"`
}
FactorySessionTarget defines model for FactorySessionTarget.
type FactorySessionTargetRef ¶ added in v0.0.5
type FactorySessionTargetRef struct {
Kind FactorySessionTargetRefKind `json:"kind"`
Name *string `json:"name,omitempty"`
}
FactorySessionTargetRef defines model for FactorySessionTargetRef.
type FactorySessionTargetRefKind ¶ added in v0.0.5
type FactorySessionTargetRefKind string
FactorySessionTargetRefKind defines model for FactorySessionTargetRef.Kind.
const ( FactorySessionTargetRefKindDefault FactorySessionTargetRefKind = "default" FactorySessionTargetRefKindNamed FactorySessionTargetRefKind = "named" )
Defines values for FactorySessionTargetRefKind.
type FactoryState ¶
type FactoryState string
FactoryState Lifecycle state of the running factory.
const ( FactoryStateCompleted FactoryState = "COMPLETED" FactoryStateFailed FactoryState = "FAILED" FactoryStateIdle FactoryState = "IDLE" FactoryStatePaused FactoryState = "PAUSED" FactoryStateRunning FactoryState = "RUNNING" )
Defines values for FactoryState.
type FactoryStateResponseEventPayload ¶
type FactoryStateResponseEventPayload struct {
// PreviousState Lifecycle state of the running factory.
PreviousState *FactoryState `json:"previousState,omitempty"`
Reason *string `json:"reason,omitempty"`
// State Lifecycle state of the running factory.
State FactoryState `json:"state"`
}
FactoryStateResponseEventPayload defines model for FactoryStateResponseEventPayload.
type FactoryValidationResult ¶ added in v0.0.5
type FactoryValidationResult struct {
// Targets Canonical validation targets for the submitted factory definition.
Targets []FactoryValidationTarget `json:"targets"`
}
FactoryValidationResult defines model for FactoryValidationResult.
type FactoryValidationSeverity ¶ added in v0.0.5
type FactoryValidationSeverity string
FactoryValidationSeverity Validation severity for one factory validation target.
const ( FactoryValidationSeverityError FactoryValidationSeverity = "error" FactoryValidationSeverityHint FactoryValidationSeverity = "hint" FactoryValidationSeverityWarning FactoryValidationSeverity = "warning" )
Defines values for FactoryValidationSeverity.
type FactoryValidationSubject ¶ added in v0.0.5
type FactoryValidationSubject struct {
// Id Stable component identifier or name for the affected factory component.
Id string `json:"id"`
// Location Factory-domain location within the subject component referenced by one validation target.
Location FactoryValidationSubjectLocation `json:"location"`
// Type Factory-domain component type referenced by one validation target subject.
Type FactoryValidationSubjectType `json:"type"`
}
FactoryValidationSubject defines model for FactoryValidationSubject.
type FactoryValidationSubjectLocation ¶ added in v0.0.5
type FactoryValidationSubjectLocation string
FactoryValidationSubjectLocation Factory-domain location within the subject component referenced by one validation target.
const ( FactoryValidationSubjectLocationDefinition FactoryValidationSubjectLocation = "DEFINITION" FactoryValidationSubjectLocationInputs FactoryValidationSubjectLocation = "INPUTS" FactoryValidationSubjectLocationOnFailure FactoryValidationSubjectLocation = "ON_FAILURE" FactoryValidationSubjectLocationOnRejection FactoryValidationSubjectLocation = "ON_REJECTION" FactoryValidationSubjectLocationOutputs FactoryValidationSubjectLocation = "OUTPUTS" FactoryValidationSubjectLocationReference FactoryValidationSubjectLocation = "REFERENCE" FactoryValidationSubjectLocationStates FactoryValidationSubjectLocation = "STATES" FactoryValidationSubjectLocationTerminal FactoryValidationSubjectLocation = "TERMINAL" )
Defines values for FactoryValidationSubjectLocation.
type FactoryValidationSubjectType ¶ added in v0.0.5
type FactoryValidationSubjectType string
FactoryValidationSubjectType Factory-domain component type referenced by one validation target subject.
const ( FactoryValidationSubjectTypeFactory FactoryValidationSubjectType = "FACTORY" FactoryValidationSubjectTypeResource FactoryValidationSubjectType = "RESOURCE" FactoryValidationSubjectTypeRoute FactoryValidationSubjectType = "ROUTE" FactoryValidationSubjectTypeWorkState FactoryValidationSubjectType = "WORK_STATE" FactoryValidationSubjectTypeWorkType FactoryValidationSubjectType = "WORK_TYPE" FactoryValidationSubjectTypeWorker FactoryValidationSubjectType = "WORKER" FactoryValidationSubjectTypeWorkstation FactoryValidationSubjectType = "WORKSTATION" )
Defines values for FactoryValidationSubjectType.
type FactoryValidationTarget ¶ added in v0.0.5
type FactoryValidationTarget struct {
// Code Stable machine-readable validation rule identifier.
Code string `json:"code"`
// Message Human-readable explanation suitable for dialogs and summaries.
Message string `json:"message"`
// Severity Validation severity for one factory validation target.
Severity FactoryValidationSeverity `json:"severity"`
Subject FactoryValidationSubject `json:"subject"`
}
FactoryValidationTarget defines model for FactoryValidationTarget.
type FactoryWorldMutationView ¶
type FactoryWorldMutationView struct {
FromPlace *string `json:"fromPlace,omitempty"`
Reason *string `json:"reason,omitempty"`
ToPlace *string `json:"toPlace,omitempty"`
Token *FactoryWorldTokenView `json:"token,omitempty"`
TokenId string `json:"tokenId"`
Type string `json:"type"`
}
FactoryWorldMutationView defines model for FactoryWorldMutationView.
type FactoryWorldProviderDiagnostic ¶
type FactoryWorldProviderDiagnostic struct {
Model *string `json:"model,omitempty"`
Provider *string `json:"provider,omitempty"`
RequestMetadata *StringMap `json:"requestMetadata,omitempty"`
ResponseMetadata *StringMap `json:"responseMetadata,omitempty"`
}
FactoryWorldProviderDiagnostic defines model for FactoryWorldProviderDiagnostic.
type FactoryWorldRenderedPromptDiagnostic ¶
type FactoryWorldRenderedPromptDiagnostic struct {
SystemPromptHash *string `json:"systemPromptHash,omitempty"`
UserMessageHash *string `json:"userMessageHash,omitempty"`
Variables *StringMap `json:"variables,omitempty"`
}
FactoryWorldRenderedPromptDiagnostic defines model for FactoryWorldRenderedPromptDiagnostic.
type FactoryWorldRunnerBaselineCapability ¶ added in v0.0.5
type FactoryWorldRunnerBaselineCapability string
FactoryWorldRunnerBaselineCapability defines model for FactoryWorldRunnerBaselineCapability.
const ( PromptSubmission FactoryWorldRunnerBaselineCapability = "prompt_submission" ToolExecution FactoryWorldRunnerBaselineCapability = "tool_execution" )
Defines values for FactoryWorldRunnerBaselineCapability.
type FactoryWorldRunnerCapabilitiesView ¶ added in v0.0.5
type FactoryWorldRunnerCapabilitiesView struct {
BaselineCapabilities []FactoryWorldRunnerBaselineCapability `json:"baselineCapabilities"`
OptionalCapabilities []FactoryWorldRunnerOptionalCapabilitySupportView `json:"optionalCapabilities"`
}
FactoryWorldRunnerCapabilitiesView defines model for FactoryWorldRunnerCapabilitiesView.
type FactoryWorldRunnerOptionalCapability ¶ added in v0.0.5
type FactoryWorldRunnerOptionalCapability string
FactoryWorldRunnerOptionalCapability defines model for FactoryWorldRunnerOptionalCapability.
const ( ImageInput FactoryWorldRunnerOptionalCapability = "image_input" SessionResume FactoryWorldRunnerOptionalCapability = "session_resume" StructuredOutput FactoryWorldRunnerOptionalCapability = "structured_output" WorkingDirectory FactoryWorldRunnerOptionalCapability = "working_directory" Worktree FactoryWorldRunnerOptionalCapability = "worktree" )
Defines values for FactoryWorldRunnerOptionalCapability.
type FactoryWorldRunnerOptionalCapabilityStatus ¶ added in v0.0.5
type FactoryWorldRunnerOptionalCapabilityStatus string
FactoryWorldRunnerOptionalCapabilityStatus defines model for FactoryWorldRunnerOptionalCapabilityStatus.
const ( Supported FactoryWorldRunnerOptionalCapabilityStatus = "supported" Unsupported FactoryWorldRunnerOptionalCapabilityStatus = "unsupported" )
Defines values for FactoryWorldRunnerOptionalCapabilityStatus.
type FactoryWorldRunnerOptionalCapabilitySupportView ¶ added in v0.0.5
type FactoryWorldRunnerOptionalCapabilitySupportView struct {
Capability FactoryWorldRunnerOptionalCapability `json:"capability"`
Detail *string `json:"detail,omitempty"`
Status FactoryWorldRunnerOptionalCapabilityStatus `json:"status"`
}
FactoryWorldRunnerOptionalCapabilitySupportView defines model for FactoryWorldRunnerOptionalCapabilitySupportView.
type FactoryWorldScriptRequestView ¶
type FactoryWorldScriptRequestView struct {
Args *[]string `json:"args,omitempty"`
Attempt *int `json:"attempt,omitempty"`
Command *string `json:"command,omitempty"`
ScriptRequestId *string `json:"scriptRequestId,omitempty"`
}
FactoryWorldScriptRequestView defines model for FactoryWorldScriptRequestView.
type FactoryWorldScriptResponseView ¶
type FactoryWorldScriptResponseView struct {
Attempt *int `json:"attempt,omitempty"`
DurationMillis *int64 `json:"durationMillis,omitempty"`
ExitCode *int `json:"exitCode,omitempty"`
FailureType *string `json:"failureType,omitempty"`
Outcome *string `json:"outcome,omitempty"`
ScriptRequestId *string `json:"scriptRequestId,omitempty"`
Stderr *string `json:"stderr,omitempty"`
Stdout *string `json:"stdout,omitempty"`
}
FactoryWorldScriptResponseView defines model for FactoryWorldScriptResponseView.
type FactoryWorldSelectedRunnerView ¶ added in v0.0.5
type FactoryWorldSelectedRunnerView struct {
Capabilities *FactoryWorldRunnerCapabilitiesView `json:"capabilities,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
// RunnerId Stable built-in runner identifiers supported by factory and workstation runner selection.
RunnerId *RunnerID `json:"runnerId,omitempty"`
// SelectionSource Configuration layer that supplied the resolved built-in runner selection for a dispatch.
SelectionSource *RunnerSelectionSource `json:"selectionSource,omitempty"`
}
FactoryWorldSelectedRunnerView defines model for FactoryWorldSelectedRunnerView.
type FactoryWorldTokenView ¶
type FactoryWorldTokenView struct {
ChainingTraceDepth *int `json:"chainingTraceDepth,omitempty"`
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
Name *string `json:"name,omitempty"`
PlaceId string `json:"placeId"`
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
Tags *StringMap `json:"tags,omitempty"`
TokenId string `json:"tokenId"`
TraceId *string `json:"traceId,omitempty"`
WorkId *string `json:"workId,omitempty"`
WorkTypeId *string `json:"workTypeId,omitempty"`
}
FactoryWorldTokenView defines model for FactoryWorldTokenView.
type FactoryWorldWorkDiagnostics ¶
type FactoryWorldWorkDiagnostics struct {
Provider *FactoryWorldProviderDiagnostic `json:"provider,omitempty"`
RenderedPrompt *FactoryWorldRenderedPromptDiagnostic `json:"renderedPrompt,omitempty"`
}
FactoryWorldWorkDiagnostics defines model for FactoryWorldWorkDiagnostics.
type FactoryWorldWorkItemRef ¶
type FactoryWorldWorkItemRef struct {
ChainingTraceDepth *int `json:"chainingTraceDepth,omitempty"`
// Content Ordered canonical content parts for one work item.
Content *WorkContent `json:"content,omitempty"`
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
LineageContinuity *FactoryWorldWorkItemRefLineageContinuity `json:"lineageContinuity,omitempty"`
LineageLogicalWorkId *string `json:"lineageLogicalWorkId,omitempty"`
LineageParentWorkIds *[]string `json:"lineageParentWorkIds,omitempty"`
LineageSourceKind *FactoryWorldWorkItemRefLineageSourceKind `json:"lineageSourceKind,omitempty"`
PayloadStatus *FactoryWorldWorkItemRefPayloadStatus `json:"payloadStatus,omitempty"`
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
State *string `json:"state,omitempty"`
TraceId *string `json:"traceId,omitempty"`
WorkId string `json:"workId"`
WorkTypeId *string `json:"workTypeId,omitempty"`
}
FactoryWorldWorkItemRef defines model for FactoryWorldWorkItemRef.
type FactoryWorldWorkItemRefLineageContinuity ¶ added in v0.0.5
type FactoryWorldWorkItemRefLineageContinuity string
FactoryWorldWorkItemRefLineageContinuity defines model for FactoryWorldWorkItemRef.LineageContinuity.
const ( INITIALSUBMISSION FactoryWorldWorkItemRefLineageContinuity = "INITIAL_SUBMISSION" NEWDOWNSTREAMWORK FactoryWorldWorkItemRefLineageContinuity = "NEW_DOWNSTREAM_WORK" SAMEWORKIDCONTINUATION FactoryWorldWorkItemRefLineageContinuity = "SAME_WORK_ID_CONTINUATION" )
Defines values for FactoryWorldWorkItemRefLineageContinuity.
type FactoryWorldWorkItemRefLineageSourceKind ¶ added in v0.0.5
type FactoryWorldWorkItemRefLineageSourceKind string
FactoryWorldWorkItemRefLineageSourceKind defines model for FactoryWorldWorkItemRef.LineageSourceKind.
const ( DISPATCHRESPONSEOUTPUT FactoryWorldWorkItemRefLineageSourceKind = "DISPATCH_RESPONSE_OUTPUT" WORKREQUEST FactoryWorldWorkItemRefLineageSourceKind = "WORK_REQUEST" )
Defines values for FactoryWorldWorkItemRefLineageSourceKind.
type FactoryWorldWorkItemRefPayloadStatus ¶ added in v0.0.5
type FactoryWorldWorkItemRefPayloadStatus string
FactoryWorldWorkItemRefPayloadStatus defines model for FactoryWorldWorkItemRef.PayloadStatus.
const ( FactoryWorldWorkItemRefPayloadStatusERROR FactoryWorldWorkItemRefPayloadStatus = "ERROR" FactoryWorldWorkItemRefPayloadStatusLOADING FactoryWorldWorkItemRefPayloadStatus = "LOADING" FactoryWorldWorkItemRefPayloadStatusRESOLVED FactoryWorldWorkItemRefPayloadStatus = "RESOLVED" FactoryWorldWorkItemRefPayloadStatusUNAVAILABLE FactoryWorldWorkItemRefPayloadStatus = "UNAVAILABLE" )
Defines values for FactoryWorldWorkItemRefPayloadStatus.
type FactoryWorldWorkMoveOperationProjectionSlice ¶ added in v0.0.5
type FactoryWorldWorkMoveOperationProjectionSlice struct {
WorkMoveOperationsByWorkId *map[string][]FactoryWorldWorkMoveOperationView `json:"workMoveOperationsByWorkId,omitempty"`
}
FactoryWorldWorkMoveOperationProjectionSlice Additive dashboard read-model contract slice that publishes per-work move operations derived from canonical WORK_STATE_CHANGE events without reintroducing removed `/dashboard` endpoints.
type FactoryWorldWorkMoveOperationView ¶ added in v0.0.5
type FactoryWorldWorkMoveOperationView struct {
EventTime *time.Time `json:"eventTime,omitempty"`
FromPlaceId string `json:"fromPlaceId"`
FromState string `json:"fromState"`
RequestId *string `json:"requestId,omitempty"`
Sequence int `json:"sequence"`
// Source Origin of a WORK_STATE_CHANGE event.
Source WorkStateChangeSource `json:"source"`
Tick int `json:"tick"`
ToPlaceId string `json:"toPlaceId"`
ToState string `json:"toState"`
WorkId string `json:"workId"`
WorkTypeName *string `json:"workTypeName,omitempty"`
}
FactoryWorldWorkMoveOperationView defines model for FactoryWorldWorkMoveOperationView.
type FactoryWorldWorkstationRequestCountView ¶
type FactoryWorldWorkstationRequestCountView struct {
DispatchedCount int `json:"dispatchedCount"`
ErroredCount int `json:"erroredCount"`
RespondedCount int `json:"respondedCount"`
}
FactoryWorldWorkstationRequestCountView defines model for FactoryWorldWorkstationRequestCountView.
type FactoryWorldWorkstationRequestProjectionSlice ¶
type FactoryWorldWorkstationRequestProjectionSlice struct {
WorkstationRequestsByDispatchId *map[string]FactoryWorldWorkstationRequestView `json:"workstationRequestsByDispatchId,omitempty"`
}
FactoryWorldWorkstationRequestProjectionSlice Additive dashboard read-model contract slice that publishes workstation-request projections keyed by dispatch ID without reintroducing removed `/dashboard` endpoints.
type FactoryWorldWorkstationRequestRequestView ¶
type FactoryWorldWorkstationRequestRequestView struct {
ConsumedTokens *[]FactoryWorldTokenView `json:"consumedTokens,omitempty"`
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
InputWorkItems *[]FactoryWorldWorkItemRef `json:"inputWorkItems,omitempty"`
InputWorkTypeIds *[]string `json:"inputWorkTypeIds,omitempty"`
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
Runner *FactoryWorldSelectedRunnerView `json:"runner,omitempty"`
ScriptRequest *FactoryWorldScriptRequestView `json:"scriptRequest,omitempty"`
StartedAt *time.Time `json:"startedAt,omitempty"`
TraceIds *[]string `json:"traceIds,omitempty"`
}
FactoryWorldWorkstationRequestRequestView defines model for FactoryWorldWorkstationRequestRequestView.
type FactoryWorldWorkstationRequestResponseView ¶
type FactoryWorldWorkstationRequestResponseView struct {
DurationMillis *int64 `json:"durationMillis,omitempty"`
EndTime *time.Time `json:"endTime,omitempty"`
FailureMessage *string `json:"failureMessage,omitempty"`
FailureReason *string `json:"failureReason,omitempty"`
Feedback *string `json:"feedback,omitempty"`
Outcome *string `json:"outcome,omitempty"`
OutputMutations *[]FactoryWorldMutationView `json:"outputMutations,omitempty"`
OutputWorkItems *[]FactoryWorldWorkItemRef `json:"outputWorkItems,omitempty"`
Runner *FactoryWorldSelectedRunnerView `json:"runner,omitempty"`
ScriptResponse *FactoryWorldScriptResponseView `json:"scriptResponse,omitempty"`
SelectedClassificationLabel *string `json:"selectedClassificationLabel,omitempty"`
}
FactoryWorldWorkstationRequestResponseView defines model for FactoryWorldWorkstationRequestResponseView.
type FactoryWorldWorkstationRequestView ¶
type FactoryWorldWorkstationRequestView struct {
Counts FactoryWorldWorkstationRequestCountView `json:"counts"`
DispatchId string `json:"dispatchId"`
Request FactoryWorldWorkstationRequestRequestView `json:"request"`
Response *FactoryWorldWorkstationRequestResponseView `json:"response,omitempty"`
TransitionId string `json:"transitionId"`
WorkstationName *string `json:"workstationName,omitempty"`
}
FactoryWorldWorkstationRequestView defines model for FactoryWorldWorkstationRequestView.
type GetProviderSessionDetailsParams ¶ added in v0.0.5
type GetProviderSessionDetailsParams struct {
// Provider Provider that emitted the session identifier. Only codex sessions are currently loadable.
Provider LoadableProviderSessionProvider `form:"provider" json:"provider"`
// Kind Provider-session identifier kind. Only session_id is currently loadable.
Kind LoadableProviderSessionKind `form:"kind" json:"kind"`
// Id Provider-session identifier to resolve. This is an identifier, not a filesystem path.
Id string `form:"id" json:"id"`
}
GetProviderSessionDetailsParams defines parameters for GetProviderSessionDetails.
type GorillaServerOptions ¶
type GorillaServerOptions struct {
BaseURL string
BaseRouter *mux.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type Guard ¶
type Guard struct {
// MatchConfig For `MATCHES_FIELDS` guards, the field-selector configuration used to compare candidate inputs.
MatchConfig *GuardMatchConfig `json:"matchConfig,omitempty"`
// MatchInput For `SAME_NAME` and `SAME_TRACE_ID` input guards, the peer input workType name from another input in the same workstation.
MatchInput *string `json:"matchInput,omitempty"`
// MaxVisits For `VISIT_COUNT` guards, the visit threshold.
MaxVisits *int `json:"maxVisits,omitempty"`
// ParentInput For parent-aware input guards, the parent workType name from another input in the same workstation.
ParentInput *string `json:"parentInput,omitempty"`
// SpawnedBy For dynamic fanout input guards, the workstation that spawns the children for count tracking.
SpawnedBy *string `json:"spawnedBy,omitempty"`
// Type Guard condition to evaluate for this workstation-level or input-level attachment.
Type GuardType `json:"type"`
// Workstation For `VISIT_COUNT` guards, the workstation whose visits are counted.
Workstation *string `json:"workstation,omitempty"`
}
Guard Shared guard attached either to a workstation as a whole or to one specific workstation input.
type GuardMatchConfig ¶
type GuardMatchConfig struct {
// InputKey Field selector resolved against each candidate input, such as `.Name` or `.Tags["_last_output"]`.
InputKey string `json:"inputKey"`
}
GuardMatchConfig defines model for GuardMatchConfig.
type GuardType ¶
type GuardType string
GuardType Guard condition attached to a workstation or one of its specific inputs.
const ( GuardTypeAllChildrenComplete GuardType = "ALL_CHILDREN_COMPLETE" GuardTypeAnyChildFailed GuardType = "ANY_CHILD_FAILED" GuardTypeInferenceThrottle GuardType = "INFERENCE_THROTTLE_GUARD" GuardTypeMatchesFields GuardType = "MATCHES_FIELDS" GuardTypeSameName GuardType = "SAME_NAME" GuardTypeSameTraceID GuardType = "SAME_TRACE_ID" GuardTypeVisitCount GuardType = "VISIT_COUNT" )
Defines values for GuardType.
type HostedLinearWorkerClaim ¶ added in v0.0.5
type HostedLinearWorkerClaim struct {
// AssigneeField Linear issue field name to use when deriving optional assignee claim metadata.
AssigneeField *string `json:"assigneeField,omitempty"`
}
HostedLinearWorkerClaim Optional claim-related configuration that v1 hosted Linear workers explicitly allow.
type HostedLinearWorkerConfig ¶ added in v0.0.5
type HostedLinearWorkerConfig struct {
// Claim Optional claim-related configuration that v1 hosted Linear workers explicitly allow.
Claim *HostedLinearWorkerClaim `json:"claim,omitempty"`
// Mapping Deterministic issue-to-work mapping fields owned by a hosted Linear worker.
Mapping *HostedLinearWorkerMapping `json:"mapping,omitempty"`
// PollInterval Optional Go duration that controls how often the hosted Linear worker polls for updates.
PollInterval *string `json:"pollInterval,omitempty"`
// StateIds Optional Linear issue-state identifiers that bound the poll source.
StateIds *[]string `json:"stateIds,omitempty"`
// TeamIds Optional Linear team identifiers that bound the poll source.
TeamIds *[]string `json:"teamIds,omitempty"`
}
HostedLinearWorkerConfig Provider-specific poller configuration for the built-in hosted Linear worker.
type HostedLinearWorkerMapping ¶ added in v0.0.5
type HostedLinearWorkerMapping struct {
// State Canonical submitted work state emitted for matched Linear issues.
State *string `json:"state,omitempty"`
// WorkType Canonical submitted work type emitted for matched Linear issues.
WorkType *string `json:"workType,omitempty"`
}
HostedLinearWorkerMapping Deterministic issue-to-work mapping fields owned by a hosted Linear worker.
type HostedWorkerAuth ¶ added in v0.0.5
type HostedWorkerAuth struct {
// SecretRef Referenced secret name that resolves the hosted provider API key at runtime.
SecretRef *string `json:"secretRef,omitempty"`
}
HostedWorkerAuth Hosted-worker authentication contract. V1 hosted workers accept only secret references rather than inline credentials or OAuth-style fields.
type HostedWorkerProvider ¶ added in v0.0.5
type HostedWorkerProvider string
HostedWorkerProvider Built-in repository-owned hosted worker providers supported by the public factory-config contract.
const (
HostedWorkerProviderLinear HostedWorkerProvider = "LINEAR"
)
Defines values for HostedWorkerProvider.
type HybridLogicalTimestamp ¶ added in v0.0.5
type HybridLogicalTimestamp struct {
// Logical Monotonic Lamport-style logical component derived from the persisted factory definition version. Serialized as a decimal string so JavaScript clients can round-trip the 64-bit value without precision loss.
Logical apitypes.Int64String `json:"logical"`
// Physical UTC physical timestamp component for the persisted factory definition version.
Physical time.Time `json:"physical"`
}
HybridLogicalTimestamp defines model for HybridLogicalTimestamp.
type InferenceOutcome ¶
type InferenceOutcome string
InferenceOutcome Result category returned by a provider inference attempt.
const ( InferenceOutcomeFailed InferenceOutcome = "FAILED" InferenceOutcomeSucceeded InferenceOutcome = "SUCCEEDED" )
Defines values for InferenceOutcome.
type InferenceRequestEventPayload ¶
type InferenceRequestEventPayload struct {
// Attempt One-based provider attempt number for this dispatch.
Attempt int `json:"attempt"`
// InferenceRequestId Stable identifier correlating this provider request with its response.
InferenceRequestId string `json:"inferenceRequestId"`
// Prompt Rendered prompt sent to the provider.
Prompt string `json:"prompt"`
// WorkingDirectory Working directory resolved for the provider attempt.
WorkingDirectory string `json:"workingDirectory"`
// Worktree Worktree path resolved for the provider attempt.
Worktree string `json:"worktree"`
}
InferenceRequestEventPayload Request details captured immediately before a model-worker provider attempt is invoked. FactoryEvent.context owns dispatch, request, trace, and work identity, and the matching dispatch-request event owns the transition identifier. Prompt content is intentionally present and should be treated as sensitive in recordings and diagnostics.
type InferenceResponseEventPayload ¶
type InferenceResponseEventPayload struct {
// Attempt One-based provider attempt number for this dispatch.
Attempt int `json:"attempt"`
// Diagnostics Dashboard-facing execution diagnostics that omit raw prompts, command stdin, and command environment values.
Diagnostics *SafeWorkDiagnostics `json:"diagnostics,omitempty"`
// DurationMillis Provider call duration in milliseconds.
DurationMillis int64 `json:"durationMillis"`
// ErrorClass Stable failure classification when available.
ErrorClass *string `json:"errorClass,omitempty"`
// ExitCode Process exit code when the provider failure exposes one.
ExitCode *int `json:"exitCode,omitempty"`
// InferenceRequestId Identifier from the matching inference request event.
InferenceRequestId string `json:"inferenceRequestId"`
// Outcome Result category returned by a provider inference attempt.
Outcome InferenceOutcome `json:"outcome"`
ProviderSession *ProviderSessionMetadata `json:"providerSession,omitempty"`
// Response Provider response text when present.
Response *string `json:"response,omitempty"`
}
InferenceResponseEventPayload Response details captured after a model-worker provider attempt returns, including success and failure outcomes correlated to the request event. FactoryEvent.context owns dispatch identity, and the matching dispatch request owns the transition identifier for this provider attempt. Safe provider diagnostics and provider-session identifiers stay on this provider-boundary event instead of being copied onto DispatchResponse.
type InitialStructureRequestEventPayload ¶
type InitialStructureRequestEventPayload struct {
// Factory Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.
Factory Factory `json:"factory"`
Metadata *StringMap `json:"metadata,omitempty"`
SourceDirectory *string `json:"sourceDirectory,omitempty"`
}
InitialStructureRequestEventPayload Runtime topology snapshot before work moves.
type InputKind ¶
type InputKind string
InputKind Kinds of input. `DEFAULT` passes opaque input through to workstations as-is.
const (
InputKindDefault InputKind = "DEFAULT"
)
Defines values for InputKind.
type InputType ¶
type InputType struct {
// Name Input type name. The reserved name "default" is implicit.
Name string `json:"name"`
// Type Kinds of input. `DEFAULT` passes opaque input through to workstations as-is.
Type InputKind `json:"type"`
}
InputType Declared types of inputs. Used to force the inputs of a certain work type to be of a certain shape, like a specific JSON structure.
type InternalError ¶
type InternalError = ErrorResponse
InternalError defines model for InternalError.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type InvokeModelJSONRequestBody ¶ added in v0.0.5
type InvokeModelJSONRequestBody = ModelInvocationRequest
InvokeModelJSONRequestBody defines body for InvokeModel for application/json ContentType.
type ListFactorySessionsResponse ¶ added in v0.0.5
type ListFactorySessionsResponse struct {
Sessions []FactorySessionSummary `json:"sessions"`
}
ListFactorySessionsResponse defines model for ListFactorySessionsResponse.
type ListModelsResponse ¶ added in v0.0.5
type ListModelsResponse struct {
// Results Discovered models exposed by the currently loaded runtime configuration.
Results []ModelSummary `json:"results"`
}
ListModelsResponse defines model for ListModelsResponse.
type ListWorkBySessionIdParams ¶ added in v0.0.5
type ListWorkBySessionIdParams struct {
// MaxResults Optional positive page size. Omit to use the default page size; non-positive values fall back to the default after successful integer binding.
MaxResults *MaxResults `form:"maxResults,omitempty" json:"maxResults,omitempty"`
// NextToken Optional base64-encoded token ID cursor.
NextToken *NextToken `form:"nextToken,omitempty" json:"nextToken,omitempty"`
// StateName Optional current work state name filter.
StateName *StateName `form:"state.name,omitempty" json:"state.name,omitempty"`
// StateType Optional current work state type filter.
StateType *StateType `form:"state.type,omitempty" json:"state.type,omitempty"`
// SortBy Optional list-work sort field. Use state.type to order by current work state type.
SortBy *ListWorkBySessionIdParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Name Optional work name filter. Matches when the work name contains this value, case-insensitively.
Name *WorkListName `form:"name,omitempty" json:"name,omitempty"`
// WorkTypeName Optional work type name filter. Matches when workTypeName equals this value exactly.
WorkTypeName *WorkListWorkTypeName `form:"workTypeName,omitempty" json:"workTypeName,omitempty"`
// TraceId Optional trace filter. Matches when traceId or currentChainingTraceId equals this value exactly.
TraceId *WorkListTraceId `form:"traceId,omitempty" json:"traceId,omitempty"`
}
ListWorkBySessionIdParams defines parameters for ListWorkBySessionId.
type ListWorkBySessionIdParamsSortBy ¶ added in v0.0.5
type ListWorkBySessionIdParamsSortBy string
ListWorkBySessionIdParamsSortBy defines parameters for ListWorkBySessionId.
const (
ListWorkBySessionIdParamsSortByStateType ListWorkBySessionIdParamsSortBy = "state.type"
)
Defines values for ListWorkBySessionIdParamsSortBy.
type ListWorkParams ¶
type ListWorkParams struct {
// MaxResults Optional positive page size. Omit to use the default page size; non-positive values fall back to the default after successful integer binding.
MaxResults *MaxResults `form:"maxResults,omitempty" json:"maxResults,omitempty"`
// NextToken Optional base64-encoded token ID cursor.
NextToken *NextToken `form:"nextToken,omitempty" json:"nextToken,omitempty"`
// StateName Optional current work state name filter.
StateName *StateName `form:"state.name,omitempty" json:"state.name,omitempty"`
// StateType Optional current work state type filter.
StateType *StateType `form:"state.type,omitempty" json:"state.type,omitempty"`
// SortBy Optional list-work sort field. Use state.type to order by current work state type.
SortBy *ListWorkParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`
// Name Optional work name filter. Matches when the work name contains this value, case-insensitively.
Name *WorkListName `form:"name,omitempty" json:"name,omitempty"`
// WorkTypeName Optional work type name filter. Matches when workTypeName equals this value exactly.
WorkTypeName *WorkListWorkTypeName `form:"workTypeName,omitempty" json:"workTypeName,omitempty"`
// TraceId Optional trace filter. Matches when traceId or currentChainingTraceId equals this value exactly.
TraceId *WorkListTraceId `form:"traceId,omitempty" json:"traceId,omitempty"`
}
ListWorkParams defines parameters for ListWork.
type ListWorkParamsSortBy ¶ added in v0.0.5
type ListWorkParamsSortBy string
ListWorkParamsSortBy defines parameters for ListWork.
const (
ListWorkParamsSortByStateType ListWorkParamsSortBy = "state.type"
)
Defines values for ListWorkParamsSortBy.
type ListWorkResponse ¶
type ListWorkResponse struct {
PaginationContext *PaginationContext `json:"paginationContext,omitempty"`
Results []Work `json:"results"`
}
ListWorkResponse defines model for ListWorkResponse.
type LoadableProviderSessionKind ¶ added in v0.0.5
type LoadableProviderSessionKind string
LoadableProviderSessionKind Canonical provider-session identifier kind for provider-session detail requests that can be loaded by the API.
const (
LoadableProviderSessionKindSessionID LoadableProviderSessionKind = "session_id"
)
Defines values for LoadableProviderSessionKind.
type LoadableProviderSessionProvider ¶ added in v0.0.5
type LoadableProviderSessionProvider string
LoadableProviderSessionProvider Canonical provider value for provider-session detail requests that can be loaded by the API.
const (
Codex LoadableProviderSessionProvider = "codex"
)
Defines values for LoadableProviderSessionProvider.
type LoadableProviderSessionRef ¶ added in v0.0.5
type LoadableProviderSessionRef struct {
// Id Provider-session identifier to resolve. This is an identifier, not a filesystem path.
Id string `json:"id"`
// Kind Canonical provider-session identifier kind for provider-session detail requests that can be loaded by the API.
Kind LoadableProviderSessionKind `json:"kind"`
// Provider Canonical provider value for provider-session detail requests that can be loaded by the API.
Provider LoadableProviderSessionProvider `json:"provider"`
}
LoadableProviderSessionRef defines model for LoadableProviderSessionRef.
type ModelCapability ¶ added in v0.0.5
type ModelCapability struct {
// ModelProvider Canonical model-provider identifiers supported by model workers in factory config.
ModelProvider *WorkerModelProvider `json:"modelProvider,omitempty"`
// Operations Operations declared by this worker for the selected model.
Operations []ModelOperation `json:"operations"`
// ProviderLocality Provider locality for a model worker capability declaration.
ProviderLocality WorkerModelLocality `json:"providerLocality"`
// ResourceNames Factory resource names referenced by the worker declaration.
ResourceNames []string `json:"resourceNames"`
// Worker Customer-authored worker name that exposes this capability declaration.
Worker string `json:"worker"`
}
ModelCapability defines model for ModelCapability.
type ModelDetail ¶ added in v0.0.5
type ModelDetail struct {
// Capabilities Worker-scoped capability declarations that contribute to this discovered model.
Capabilities []ModelCapability `json:"capabilities"`
Diagnostics StringMap `json:"diagnostics"`
// LoadState Runtime-visible load state for one discovered model. Before local model-manager support lands, local discovered models report `UNLOADED` and cloud-backed models report `NOT_APPLICABLE`.
LoadState ModelLoadState `json:"loadState"`
// Modalities Uppercase content modalities observed across all declared operation inputs and outputs.
Modalities []ModelOperationContentType `json:"modalities"`
// Name Concrete public model identifier such as `OMNIVOICE_Q4_K_M`.
Name string `json:"name"`
// Operations Union of provider-agnostic operations supported by workers for this model.
Operations []ModelOperation `json:"operations"`
// ProviderLocality Provider locality for a model worker capability declaration.
ProviderLocality WorkerModelLocality `json:"providerLocality"`
// Resources Factory resource summaries associated with this model's workers or explicit model metadata.
Resources []ModelResourceSummary `json:"resources"`
// Status Readiness status derived from the currently loaded runtime configuration and declared resources for one discovered model.
Status ModelStatus `json:"status"`
}
ModelDetail defines model for ModelDetail.
type ModelInvocationOptions ¶ added in v0.0.5
type ModelInvocationOptions struct {
// ResponseMode Requested direct-invocation response mode.
ResponseMode *ModelInvocationResponseMode `json:"responseMode,omitempty"`
}
ModelInvocationOptions Optional direct-invocation controls for response shaping and transport.
type ModelInvocationRequest ¶ added in v0.0.5
type ModelInvocationRequest struct {
// Bindings Optional per-request slot bindings that follow the same contract as `MODEL_INVOKE` workstation bindings.
Bindings *[]WorkstationOperationBinding `json:"bindings,omitempty"`
// Content Ordered canonical content parts for one work item.
Content *WorkContent `json:"content,omitempty"`
// Operation Uppercase provider-agnostic operation to invoke, such as `TTS`.
Operation string `json:"operation"`
// Options Optional direct-invocation controls for response shaping and transport.
Options *ModelInvocationOptions `json:"options,omitempty"`
}
ModelInvocationRequest defines model for ModelInvocationRequest.
type ModelInvocationResponse ¶ added in v0.0.5
type ModelInvocationResponse struct {
// Bindings Deterministically resolved slot bindings used for the invocation.
Bindings []ResolvedModelOperationBinding `json:"bindings"`
// Content Ordered canonical content parts for one work item.
Content WorkContent `json:"content"`
// ModelName Concrete public model identifier such as `OMNIVOICE_Q4_K_M`.
ModelName string `json:"modelName"`
// Operation Uppercase provider-agnostic operation that was invoked.
Operation string `json:"operation"`
// ProviderLocality Provider locality for a model worker capability declaration.
ProviderLocality WorkerModelLocality `json:"providerLocality"`
// Worker Worker selected to satisfy this invocation.
Worker string `json:"worker"`
}
ModelInvocationResponse defines model for ModelInvocationResponse.
type ModelInvocationResponseMode ¶ added in v0.0.5
type ModelInvocationResponseMode string
ModelInvocationResponseMode Requested direct-invocation response mode.
const ( AUDIOSTREAM ModelInvocationResponseMode = "AUDIO_STREAM" METADATA ModelInvocationResponseMode = "METADATA" )
Defines values for ModelInvocationResponseMode.
type ModelLoadState ¶ added in v0.0.5
type ModelLoadState string
ModelLoadState Runtime-visible load state for one discovered model. Before local model-manager support lands, local discovered models report `UNLOADED` and cloud-backed models report `NOT_APPLICABLE`.
const ( NOTAPPLICABLE ModelLoadState = "NOT_APPLICABLE" UNLOADED ModelLoadState = "UNLOADED" )
Defines values for ModelLoadState.
type ModelOperation ¶ added in v0.0.5
type ModelOperation struct {
// Inputs Named operation input slots this worker can consume.
Inputs *[]ModelOperationSlot `json:"inputs,omitempty"`
// Name Uppercase public operation identifier such as `TTS`, `ASR`, or `EMBED`.
Name ModelOperationName `json:"name"`
// Outputs Named operation output slots this worker can produce.
Outputs *[]ModelOperationSlot `json:"outputs,omitempty"`
}
ModelOperation One provider-agnostic operation exposed by a model worker, such as `TTS`.
type ModelOperationContentType ¶ added in v0.0.5
type ModelOperationContentType string
ModelOperationContentType Uppercase content-part categories supported by worker model-operation capability slots.
const ( ModelOperationContentTypeAudio ModelOperationContentType = "AUDIO" ModelOperationContentTypeBinary ModelOperationContentType = "BINARY" ModelOperationContentTypeImage ModelOperationContentType = "IMAGE" ModelOperationContentTypeJSON ModelOperationContentType = "JSON" ModelOperationContentTypeText ModelOperationContentType = "TEXT" )
Defines values for ModelOperationContentType.
type ModelOperationName ¶ added in v0.0.5
type ModelOperationName = string
ModelOperationName Uppercase public operation identifier such as `TTS`, `ASR`, or `EMBED`.
type ModelOperationSlot ¶ added in v0.0.5
type ModelOperationSlot struct {
// ContentTypes Uppercase content types accepted or produced by this slot.
ContentTypes []ModelOperationContentType `json:"contentTypes"`
// Name Stable slot name used by workstation-side bindings and diagnostics.
Name string `json:"name"`
// Required Whether this input slot must be resolved before invocation starts. Output slots omit this field when not needed.
Required *bool `json:"required,omitempty"`
}
ModelOperationSlot One named capability slot declared by a model operation.
type ModelPullDownloadedFile ¶ added in v0.0.5
type ModelPullDownloadedFile struct {
// Bytes Downloaded file size in bytes.
Bytes int64 `json:"bytes"`
// Path Relative file path written under the managed model cache directory.
Path string `json:"path"`
// Sha256 Lowercase SHA-256 checksum for the cached file when known.
Sha256 *string `json:"sha256,omitempty"`
}
ModelPullDownloadedFile defines model for ModelPullDownloadedFile.
type ModelPullOutcome ¶ added in v0.0.5
type ModelPullOutcome string
ModelPullOutcome Outcome of a managed local-model asset pull request.
const ( ALREADYPRESENT ModelPullOutcome = "ALREADY_PRESENT" PULLED ModelPullOutcome = "PULLED" )
Defines values for ModelPullOutcome.
type ModelPullResponse ¶ added in v0.0.5
type ModelPullResponse struct {
// CachePath Final managed cache directory that now contains the pulled model assets.
CachePath string `json:"cachePath"`
// DownloadedFiles Files that were downloaded or verified as already present for the managed cache entry.
DownloadedFiles []ModelPullDownloadedFile `json:"downloadedFiles"`
// ModelName Concrete public model identifier such as `OMNIVOICE_Q4_K_M`.
ModelName string `json:"modelName"`
// Outcome Outcome of a managed local-model asset pull request.
Outcome ModelPullOutcome `json:"outcome"`
// ProviderLocality Provider locality for a model worker capability declaration.
ProviderLocality WorkerModelLocality `json:"providerLocality"`
// Revision Pulled source revision identifier, such as an upstream repository commit SHA.
Revision string `json:"revision"`
}
ModelPullResponse defines model for ModelPullResponse.
type ModelRequestEventPayload ¶ added in v0.0.5
type ModelRequestEventPayload struct {
// Attempt One-based model execution attempt number for this dispatch.
Attempt int `json:"attempt"`
// Bindings Deterministically resolved operation-slot bindings used for invocation.
Bindings *[]ResolvedModelOperationBinding `json:"bindings,omitempty"`
// Model Concrete model identity resolved for this invocation.
Model string `json:"model"`
// ModelRequestId Stable identifier correlating this model execution request with its response.
ModelRequestId string `json:"modelRequestId"`
// Operation Uppercase model operation requested by the workstation, such as TTS.
Operation string `json:"operation"`
// ProviderLocality Worker-declared model locality, such as LOCAL or CLOUD.
ProviderLocality string `json:"providerLocality"`
// Resources Concrete resources attached to the model worker execution path.
Resources *[]ModelResourceSummary `json:"resources,omitempty"`
// Worker Runtime worker name selected for the invocation.
Worker string `json:"worker"`
// WorkingDirectory Working directory resolved for the model execution when present.
WorkingDirectory *string `json:"workingDirectory,omitempty"`
// Worktree Worktree path resolved for the model execution when present.
Worktree *string `json:"worktree,omitempty"`
}
ModelRequestEventPayload Request details captured immediately before a model-backed worker invocation enters resource, load, and execution boundaries. FactoryEvent.context owns dispatch, request, trace, and work identity, and the matching dispatch-request event owns the transition identifier.
type ModelResourceSummary ¶ added in v0.0.5
type ModelResourceSummary struct {
// Backend Local runtime backend identifier for model resources.
Backend *string `json:"backend,omitempty"`
// Capacity Declared factory capacity for this resource.
Capacity int `json:"capacity"`
// LoadPolicy Local load-policy metadata for model resources.
LoadPolicy *string `json:"loadPolicy,omitempty"`
// Model Concrete model identifier when the resource is model-specific.
Model *string `json:"model,omitempty"`
// Name Factory-authored resource name.
Name string `json:"name"`
// Provider Cloud provider identity when the resource models quota or routing.
Provider *string `json:"provider,omitempty"`
// Type Uppercase resource families supported by the public factory-config contract.
Type ResourceType `json:"type"`
}
ModelResourceSummary defines model for ModelResourceSummary.
type ModelResponseEventPayload ¶ added in v0.0.5
type ModelResponseEventPayload struct {
// Attempt One-based model execution attempt number for this dispatch.
Attempt int `json:"attempt"`
// Bindings Deterministically resolved operation-slot bindings used for invocation.
Bindings *[]ResolvedModelOperationBinding `json:"bindings,omitempty"`
// Diagnostics Dashboard-facing execution diagnostics that omit raw prompts, command stdin, and command environment values.
Diagnostics *SafeWorkDiagnostics `json:"diagnostics,omitempty"`
// DurationMillis End-to-end model invocation duration in milliseconds.
DurationMillis int64 `json:"durationMillis"`
// ErrorClass Stable failure classification when available.
ErrorClass *string `json:"errorClass,omitempty"`
// LoadDurationMillis Duration of the managed local-model load call when one occurred.
LoadDurationMillis *int64 `json:"loadDurationMillis,omitempty"`
// LoadRequested Whether this invocation asked the managed local-model runtime to load a handle.
LoadRequested *bool `json:"loadRequested,omitempty"`
// LoadReused Whether an already-loaded local model handle was reused instead of loading again.
LoadReused *bool `json:"loadReused,omitempty"`
// Model Concrete model identity resolved for this invocation.
Model string `json:"model"`
// ModelRequestId Identifier from the matching model request event.
ModelRequestId string `json:"modelRequestId"`
// Operation Uppercase model operation requested by the workstation, such as TTS.
Operation string `json:"operation"`
// Outcome Result category returned by a provider inference attempt.
Outcome InferenceOutcome `json:"outcome"`
// OutputContent Ordered canonical content parts for one work item.
OutputContent *WorkContent `json:"outputContent,omitempty"`
// OutputPreview Bounded output preview for non-binary model responses when present.
OutputPreview *string `json:"outputPreview,omitempty"`
// ProviderLocality Worker-declared model locality, such as LOCAL or CLOUD.
ProviderLocality string `json:"providerLocality"`
// ResourceAcquired Whether the invocation acquired the required local model resources.
ResourceAcquired *bool `json:"resourceAcquired,omitempty"`
// ResourceWaitMillis Time spent waiting for local model resources before acquisition.
ResourceWaitMillis *int64 `json:"resourceWaitMillis,omitempty"`
// Resources Concrete resources attached to the model worker execution path.
Resources *[]ModelResourceSummary `json:"resources,omitempty"`
// Worker Runtime worker name selected for the invocation.
Worker string `json:"worker"`
}
ModelResponseEventPayload Response details captured after a model-backed worker invocation returns, including resource wait, local load, binding-resolution, output, and failure evidence correlated to the matching model request event. Large binary audio must remain represented through content references or bounded previews instead of unbounded inline payloads.
type ModelStatus ¶ added in v0.0.5
type ModelStatus string
ModelStatus Readiness status derived from the currently loaded runtime configuration and declared resources for one discovered model.
const ( ModelStatusREADY ModelStatus = "READY" ModelStatusUNAVAILABLE ModelStatus = "UNAVAILABLE" )
Defines values for ModelStatus.
type ModelSummary ¶ added in v0.0.5
type ModelSummary struct {
// LoadState Runtime-visible load state for one discovered model. Before local model-manager support lands, local discovered models report `UNLOADED` and cloud-backed models report `NOT_APPLICABLE`.
LoadState ModelLoadState `json:"loadState"`
// Modalities Uppercase content modalities observed across the model's declared operation inputs and outputs.
Modalities []ModelOperationContentType `json:"modalities"`
// Name Concrete public model identifier such as `OMNIVOICE_Q4_K_M`.
Name string `json:"name"`
// Operations Provider-agnostic operations supported by the discovered model.
Operations []ModelOperation `json:"operations"`
// ProviderLocality Provider locality for a model worker capability declaration.
ProviderLocality WorkerModelLocality `json:"providerLocality"`
// Resources Factory resource summaries associated with this model's workers or explicit model metadata.
Resources []ModelResourceSummary `json:"resources"`
// Status Readiness status derived from the currently loaded runtime configuration and declared resources for one discovered model.
Status ModelStatus `json:"status"`
}
ModelSummary defines model for ModelSummary.
type MoveWorkBySessionIdJSONRequestBody ¶ added in v0.0.5
type MoveWorkBySessionIdJSONRequestBody = MoveWorkRequest
MoveWorkBySessionIdJSONRequestBody defines body for MoveWorkBySessionId for application/json ContentType.
type MoveWorkConflict ¶ added in v0.0.5
type MoveWorkConflict = ErrorResponse
MoveWorkConflict defines model for MoveWorkConflict.
type MoveWorkJSONRequestBody ¶ added in v0.0.5
type MoveWorkJSONRequestBody = MoveWorkRequest
MoveWorkJSONRequestBody defines body for MoveWork for application/json ContentType.
type MoveWorkRequest ¶ added in v0.0.5
type MoveWorkRequest struct {
// RequestId Optional client idempotency key. Repeating the same requestId for an already-applied operator move returns 409 Conflict without a second mutation.
RequestId *string `json:"requestId,omitempty"`
// StateName Authored marking state name to move the work item into.
StateName string `json:"stateName"`
}
MoveWorkRequest Operator request to move one work item to another authored marking state.
type OpenFactorySessionJSONRequestBody ¶ added in v0.0.5
type OpenFactorySessionJSONRequestBody = OpenFactorySessionRequest
OpenFactorySessionJSONRequestBody defines body for OpenFactorySession for application/json ContentType.
type OpenFactorySessionRequest ¶ added in v0.0.5
type OpenFactorySessionRequest struct {
FolderPath string `json:"folderPath"`
// InitNewFactory When true, write the default init scaffold at folderPath and open a live session. Mutually exclusive with validateOnly.
InitNewFactory *bool `json:"initNewFactory,omitempty"`
Target *FactorySessionTargetRef `json:"target,omitempty"`
// ValidateOnly When true, validate the folder and optional target selection without creating a live session.
ValidateOnly *bool `json:"validateOnly,omitempty"`
}
OpenFactorySessionRequest defines model for OpenFactorySessionRequest.
type OpenFactorySessionResponse ¶ added in v0.0.5
type OpenFactorySessionResponse struct {
// FolderPath Absolute resolved session folder path when initsNewFactory is true.
FolderPath *string `json:"folderPath,omitempty"`
// InitsNewFactory When true, validate-only inspection found a readable folder with no runnable factory targets; the client may offer to create the default init scaffold at folderPath.
InitsNewFactory *bool `json:"initsNewFactory,omitempty"`
Session *FactorySessionSummary `json:"session,omitempty"`
Targets *[]FactorySessionTarget `json:"targets,omitempty"`
}
OpenFactorySessionResponse defines model for OpenFactorySessionResponse.
type PaginationContext ¶
type PaginationContext struct {
MaxResults int `json:"maxResults"`
NextToken *string `json:"nextToken,omitempty"`
}
PaginationContext defines model for PaginationContext.
type PanicDiagnostic ¶
type PanicDiagnostic struct {
Message *string `json:"message,omitempty"`
Stack *string `json:"stack,omitempty"`
}
PanicDiagnostic defines model for PanicDiagnostic.
type PromptTemplateContract ¶ added in v0.0.5
type PromptTemplateContract struct {
// AvailableVariables Available prompt-template variables for the selected workstation editing context.
AvailableVariables []PromptTemplateVariableReference `json:"availableVariables"`
// InputCount Number of authored inputs on the selected workstation, which controls valid `.Inputs[N]` access.
InputCount int `json:"inputCount"`
UnavailableAccessPatterns []PromptTemplateUnavailableAccessPattern `json:"unavailableAccessPatterns"`
}
PromptTemplateContract defines model for PromptTemplateContract.
type PromptTemplateDiagnostic ¶ added in v0.0.5
type PromptTemplateDiagnostic struct {
// EndOffset Inclusive 1-based byte offset where the diagnostic source span ends when available.
EndOffset int `json:"endOffset"`
// Kind Diagnostic classification for prompt-template validation.
Kind PromptTemplateDiagnosticKind `json:"kind"`
// Message User-readable explanation of the validation failure.
Message string `json:"message"`
// Path Canonical variable path or access pattern involved in the diagnostic when available.
Path string `json:"path"`
// SourceText Source variable or access expression that triggered the diagnostic when available.
SourceText string `json:"sourceText"`
// StartOffset Inclusive 1-based byte offset where the diagnostic source span starts when available.
StartOffset int `json:"startOffset"`
}
PromptTemplateDiagnostic defines model for PromptTemplateDiagnostic.
type PromptTemplateDiagnosticKind ¶ added in v0.0.5
type PromptTemplateDiagnosticKind string
PromptTemplateDiagnosticKind Diagnostic classification for prompt-template validation.
const ( INVALIDVARIABLE PromptTemplateDiagnosticKind = "INVALID_VARIABLE" SYNTAXERROR PromptTemplateDiagnosticKind = "SYNTAX_ERROR" UNAVAILABLEVARIABLE PromptTemplateDiagnosticKind = "UNAVAILABLE_VARIABLE" )
Defines values for PromptTemplateDiagnosticKind.
type PromptTemplateUnavailableAccessPattern ¶ added in v0.0.5
type PromptTemplateUnavailableAccessPattern struct {
Example string `json:"example"`
Path string `json:"path"`
Reason string `json:"reason"`
}
PromptTemplateUnavailableAccessPattern defines model for PromptTemplateUnavailableAccessPattern.
type PromptTemplateValidationRequest ¶ added in v0.0.5
type PromptTemplateValidationRequest struct {
// Prompt Prompt draft to validate against the selected current-factory workstation contract.
Prompt string `json:"prompt"`
}
PromptTemplateValidationRequest defines model for PromptTemplateValidationRequest.
type PromptTemplateValidationResult ¶ added in v0.0.5
type PromptTemplateValidationResult struct {
// Diagnostics Typed validation diagnostics for the submitted prompt draft.
Diagnostics []PromptTemplateDiagnostic `json:"diagnostics"`
// Valid True when the prompt contains no syntax or variable diagnostics.
Valid bool `json:"valid"`
}
PromptTemplateValidationResult defines model for PromptTemplateValidationResult.
type PromptTemplateVariableReference ¶ added in v0.0.5
type PromptTemplateVariableReference struct {
// Category High-level grouping for the variable reference.
Category PromptTemplateVariableReferenceCategory `json:"category"`
// Description User-readable description of what the variable resolves to.
Description string `json:"description"`
// Example Go template snippet that shows how to reference the variable.
Example string `json:"example"`
// Path Canonical variable path summary used in diagnostics and help surfaces.
Path string `json:"path"`
}
PromptTemplateVariableReference defines model for PromptTemplateVariableReference.
type PromptTemplateVariableReferenceCategory ¶ added in v0.0.5
type PromptTemplateVariableReferenceCategory string
PromptTemplateVariableReferenceCategory High-level grouping for the variable reference.
const ( PromptTemplateVariableReferenceCategoryCONTEXT PromptTemplateVariableReferenceCategory = "CONTEXT" PromptTemplateVariableReferenceCategoryHISTORY PromptTemplateVariableReferenceCategory = "HISTORY" PromptTemplateVariableReferenceCategoryINPUT PromptTemplateVariableReferenceCategory = "INPUT" PromptTemplateVariableReferenceCategoryMAPACCESS PromptTemplateVariableReferenceCategory = "MAP_ACCESS" PromptTemplateVariableReferenceCategoryROOT PromptTemplateVariableReferenceCategory = "ROOT" )
Defines values for PromptTemplateVariableReferenceCategory.
type ProviderDiagnostic ¶
type ProviderDiagnostic struct {
Model *string `json:"model,omitempty"`
Provider *string `json:"provider,omitempty"`
RequestMetadata *StringMap `json:"requestMetadata,omitempty"`
ResponseMetadata *StringMap `json:"responseMetadata,omitempty"`
}
ProviderDiagnostic defines model for ProviderDiagnostic.
type ProviderFailureMetadata ¶
type ProviderFailureMetadata struct {
// Family Stable machine-readable failure family used to decide retry and routing behavior for failed work.
Family *WorkFailureFamily `json:"family,omitempty"`
// Type Stable machine-readable failure type used to classify failed work across providers and runtimes.
Type *WorkFailureType `json:"type,omitempty"`
}
ProviderFailureMetadata defines model for ProviderFailureMetadata.
type ProviderSessionDetailResponse ¶ added in v0.0.5
type ProviderSessionDetailResponse struct {
Parse ProviderSessionParseSummary `json:"parse"`
ProviderSession LoadableProviderSessionRef `json:"providerSession"`
Source ProviderSessionSourceMetadata `json:"source"`
// Transcript Ordered transcript entries extracted from the provider-session stream.
Transcript []ProviderSessionTranscriptEntry `json:"transcript"`
}
ProviderSessionDetailResponse defines model for ProviderSessionDetailResponse.
type ProviderSessionFunctionCallSummary ¶ added in v0.0.5
type ProviderSessionFunctionCallSummary struct {
// Arguments Compact argument payload when present.
Arguments *string `json:"arguments,omitempty"`
// CallId Provider call identifier when present in the session stream.
CallId *string `json:"callId,omitempty"`
// Name Function or tool name when present.
Name *string `json:"name,omitempty"`
// Order Chronological order of the function or tool call in the session stream.
Order int `json:"order"`
// Output Compact output payload when present.
Output *string `json:"output,omitempty"`
// Status Result status inferred from the call output or explicit status fields.
Status *string `json:"status,omitempty"`
// TurnIndex One-based execution turn index associated with the call when inferable.
TurnIndex *int `json:"turnIndex,omitempty"`
// Type Raw response item type for the call, such as function_call or custom_tool_call.
Type string `json:"type"`
}
ProviderSessionFunctionCallSummary defines model for ProviderSessionFunctionCallSummary.
type ProviderSessionLineError ¶ added in v0.0.5
type ProviderSessionLineError struct {
// LineNumber One-based line number of the malformed event-stream record.
LineNumber int `json:"lineNumber"`
// Message Client-safe parse error message for the malformed line.
Message string `json:"message"`
}
ProviderSessionLineError defines model for ProviderSessionLineError.
type ProviderSessionMetadata ¶
type ProviderSessionMetadata struct {
Id *string `json:"id,omitempty"`
Kind *string `json:"kind,omitempty"`
Provider *string `json:"provider,omitempty"`
}
ProviderSessionMetadata defines model for ProviderSessionMetadata.
type ProviderSessionParseSummary ¶ added in v0.0.5
type ProviderSessionParseSummary struct {
// EventCount Number of JSON event records parsed from the session stream.
EventCount int `json:"eventCount"`
// FunctionCalls Function and tool calls observed in chronological order.
FunctionCalls []ProviderSessionFunctionCallSummary `json:"functionCalls"`
// LineCount Number of non-empty event-stream lines inspected.
LineCount int `json:"lineCount"`
// MalformedLineCount Number of non-empty lines that could not be parsed as JSON objects.
MalformedLineCount int `json:"malformedLineCount"`
// ParseErrors Line-level parse errors for malformed event-stream records.
ParseErrors []ProviderSessionLineError `json:"parseErrors"`
// Reasoning Reasoning entries or summaries observed in chronological order.
Reasoning []ProviderSessionReasoningSummary `json:"reasoning"`
TokenUsage *ProviderSessionTokenUsage `json:"tokenUsage,omitempty"`
// Turns Chronological execution turns inferred from turn boundaries and response activity.
Turns []ProviderSessionTurnSummary `json:"turns"`
// UnknownEventCount Number of parsed JSON events without a recognized type field.
UnknownEventCount int `json:"unknownEventCount"`
// UnknownEvents Compact list of events with unknown or unsupported type fields.
UnknownEvents []ProviderSessionUnknownEvent `json:"unknownEvents"`
}
ProviderSessionParseSummary defines model for ProviderSessionParseSummary.
type ProviderSessionReasoningSummary ¶ added in v0.0.5
type ProviderSessionReasoningSummary struct {
// Encrypted Whether the reasoning entry only exposed encrypted content.
Encrypted *bool `json:"encrypted,omitempty"`
// EncryptedContent Compact encrypted reasoning payload when the provider exposes it.
EncryptedContent *string `json:"encryptedContent,omitempty"`
// Order Chronological order of the reasoning entry in the session stream.
Order int `json:"order"`
// SourceType Event or response item type that carried the reasoning entry.
SourceType string `json:"sourceType"`
// Summary Compact reasoning summary when present.
Summary *string `json:"summary,omitempty"`
// Text Reasoning text when plaintext content is present.
Text *string `json:"text,omitempty"`
// TurnIndex One-based execution turn index associated with the reasoning entry when inferable.
TurnIndex *int `json:"turnIndex,omitempty"`
}
ProviderSessionReasoningSummary defines model for ProviderSessionReasoningSummary.
type ProviderSessionSourceMetadata ¶ added in v0.0.5
type ProviderSessionSourceMetadata struct {
// ModifiedAt Filesystem modification time when available.
ModifiedAt *time.Time `json:"modifiedAt,omitempty"`
// RelativePath Path to the loaded session file relative to the configured provider sessions root.
RelativePath string `json:"relativePath"`
// SizeBytes Size of the loaded session file in bytes.
SizeBytes int64 `json:"sizeBytes"`
}
ProviderSessionSourceMetadata defines model for ProviderSessionSourceMetadata.
type ProviderSessionTokenUsage ¶ added in v0.0.5
type ProviderSessionTokenUsage struct {
CachedInputTokens *int `json:"cachedInputTokens,omitempty"`
InputTokens *int `json:"inputTokens,omitempty"`
OutputTokens *int `json:"outputTokens,omitempty"`
ReasoningOutputTokens *int `json:"reasoningOutputTokens,omitempty"`
TotalTokens *int `json:"totalTokens,omitempty"`
}
ProviderSessionTokenUsage defines model for ProviderSessionTokenUsage.
type ProviderSessionTranscriptEntry ¶ added in v0.0.5
type ProviderSessionTranscriptEntry struct {
// Arguments Compact tool-call arguments when present.
Arguments *string `json:"arguments,omitempty"`
// CallId Provider tool-call identifier when present.
CallId *string `json:"callId,omitempty"`
// Encrypted Whether the entry only exposed encrypted content instead of plaintext.
Encrypted *bool `json:"encrypted,omitempty"`
// EncryptedContent Compact encrypted reasoning payload when the provider exposes it.
EncryptedContent *string `json:"encryptedContent,omitempty"`
// LineNumber One-based JSONL line number that produced this transcript entry when applicable.
LineNumber *int `json:"lineNumber,omitempty"`
// Name Tool or function name when present.
Name *string `json:"name,omitempty"`
// Order Stable chronological order of the transcript entry in the session stream.
Order int `json:"order"`
// Output Compact tool output when present.
Output *string `json:"output,omitempty"`
// SourceType Raw provider event or item type that produced this transcript entry.
SourceType *string `json:"sourceType,omitempty"`
// Status Provider or inferred status value when present.
Status *string `json:"status,omitempty"`
// Summary Compact summary text when the provider emits a separate summary channel.
Summary *string `json:"summary,omitempty"`
// Text Plaintext transcript body when present.
Text *string `json:"text,omitempty"`
// Timestamp Provider event timestamp when present in the source session stream.
Timestamp *time.Time `json:"timestamp,omitempty"`
// TurnIndex One-based inferred turn index when the session parser can associate the entry with a turn.
TurnIndex *int `json:"turnIndex,omitempty"`
// Type Canonical transcript entry type used by the dashboard transcript view.
Type ProviderSessionTranscriptEntryType `json:"type"`
}
ProviderSessionTranscriptEntry defines model for ProviderSessionTranscriptEntry.
type ProviderSessionTranscriptEntryType ¶ added in v0.0.5
type ProviderSessionTranscriptEntryType string
ProviderSessionTranscriptEntryType Canonical transcript entry type used by the dashboard transcript view.
const ( AssistantMessage ProviderSessionTranscriptEntryType = "assistant_message" Reasoning ProviderSessionTranscriptEntryType = "reasoning" SystemEvent ProviderSessionTranscriptEntryType = "system_event" ToolCall ProviderSessionTranscriptEntryType = "tool_call" ToolOutput ProviderSessionTranscriptEntryType = "tool_output" UserMessage ProviderSessionTranscriptEntryType = "user_message" )
Defines values for ProviderSessionTranscriptEntryType.
type ProviderSessionTurnSummary ¶ added in v0.0.5
type ProviderSessionTurnSummary struct {
// EventCount Number of parsed events associated with the turn.
EventCount int `json:"eventCount"`
// FunctionCallCount Number of function or tool calls associated with the turn.
FunctionCallCount int `json:"functionCallCount"`
// Index One-based chronological execution turn index.
Index int `json:"index"`
// ReasoningCount Number of reasoning entries associated with the turn.
ReasoningCount int `json:"reasoningCount"`
// ResponseItemCount Number of response_item records associated with the turn.
ResponseItemCount int `json:"responseItemCount"`
// StartedAt First event timestamp associated with the turn when present.
StartedAt *time.Time `json:"startedAt,omitempty"`
}
ProviderSessionTurnSummary defines model for ProviderSessionTurnSummary.
type ProviderSessionUnknownEvent ¶ added in v0.0.5
type ProviderSessionUnknownEvent struct {
// LineNumber One-based line number of the unknown event.
LineNumber int `json:"lineNumber"`
// PayloadType Raw nested payload type when present.
PayloadType *string `json:"payloadType,omitempty"`
// Type Raw top-level event type when present.
Type *string `json:"type,omitempty"`
}
ProviderSessionUnknownEvent defines model for ProviderSessionUnknownEvent.
type Relation ¶
type Relation struct {
RequiredState *string `json:"requiredState,omitempty"`
SourceWorkName string `json:"sourceWorkName"`
TargetWorkId *string `json:"targetWorkId,omitempty"`
TargetWorkName string `json:"targetWorkName"`
// Type Relationship category between two pieces of work.
Type RelationType `json:"type"`
}
Relation defines model for Relation.
type RelationType ¶
type RelationType string
RelationType Relationship category between two pieces of work.
const ( RelationTypeDependsOn RelationType = "DEPENDS_ON" RelationTypeParentChild RelationType = "PARENT_CHILD" RelationTypeSpawnedBy RelationType = "SPAWNED_BY" )
Defines values for RelationType.
type RelationshipChangeRequestEventPayload ¶
type RelationshipChangeRequestEventPayload struct {
Relation Relation `json:"relation"`
}
RelationshipChangeRequestEventPayload defines model for RelationshipChangeRequestEventPayload.
type RenderedPromptDiagnostic ¶
type RenderedPromptDiagnostic struct {
SystemPromptHash *string `json:"systemPromptHash,omitempty"`
UserMessageHash *string `json:"userMessageHash,omitempty"`
Variables *StringMap `json:"variables,omitempty"`
}
RenderedPromptDiagnostic defines model for RenderedPromptDiagnostic.
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type RequiredTool ¶
type RequiredTool struct {
// Command Executable lookup token that must resolve on PATH.
Command string `json:"command"`
// Name Human-readable tool name used in manifests and validation output.
Name string `json:"name"`
// Purpose Optional explanation of why the portable factory requires this tool.
Purpose *string `json:"purpose,omitempty"`
// VersionArgs Optional argument vector used by future validation flows to probe the tool version without changing the executable lookup token.
VersionArgs *[]string `json:"versionArgs,omitempty"`
}
RequiredTool One declarative external tool dependency for a portable factory.
type ResolvedModelOperationBinding ¶ added in v0.0.5
type ResolvedModelOperationBinding struct {
// Content Ordered canonical content parts for one work item.
Content WorkContent `json:"content"`
// Slot Stable input slot name declared by the worker capability.
Slot string `json:"slot"`
// Source Source used to resolve one invocation slot binding.
Source ResolvedModelOperationBindingSource `json:"source"`
}
ResolvedModelOperationBinding defines model for ResolvedModelOperationBinding.
type ResolvedModelOperationBindingSource ¶ added in v0.0.5
type ResolvedModelOperationBindingSource string
ResolvedModelOperationBindingSource Source used to resolve one invocation slot binding.
const ( CONFIG ResolvedModelOperationBindingSource = "CONFIG" DEFAULT ResolvedModelOperationBindingSource = "DEFAULT" INPUT ResolvedModelOperationBindingSource = "INPUT" OMITTED ResolvedModelOperationBindingSource = "OMITTED" )
Defines values for ResolvedModelOperationBindingSource.
type Resource ¶
type Resource struct {
// Backend Backend identifier for local model resources, such as a managed runtime or embedded inference backend.
Backend *string `json:"backend,omitempty"`
// Capacity Total units of this resource available to the factory at one time.
Capacity int `json:"capacity"`
// LoadPolicy Load policy for local model resources, such as `ON_DEMAND` or `EAGER`.
LoadPolicy *string `json:"loadPolicy,omitempty"`
// Model Concrete model identifier associated with this resource, such as `OMNIVOICE_Q4_K_M`.
Model *string `json:"model,omitempty"`
// Name Resource name referenced from worker requirements and workstation resourceUsage entries.
Name string `json:"name"`
// Provider Provider identity associated with this resource, especially for `PROVIDER_QUOTA` resources.
Provider *string `json:"provider,omitempty"`
// Type Uppercase resource families supported by the public factory-config contract.
Type *ResourceType `json:"type,omitempty"`
}
Resource Shared capacity that limits how much work the factory can run at once, such as worker slots or external service quotas.
type ResourceManifest ¶
type ResourceManifest struct {
// BundledFiles Portable bundled files that belong inside the factory boundary. Entries are explicit only, use factory-relative target paths, and must stay under the canonical script, docs, or inputs roots for SCRIPT, DOC, or INPUT entries, or match the supported root-helper allowlist for ROOT_HELPER entries. In v1 shared-factory flows, INPUT entries capture the source factory's current starter work at share time and are restored as independent recipient copies.
BundledFiles *[]BundledFile `json:"bundledFiles,omitempty"`
// RequiredTools Declarative external tools that must already resolve on PATH. These entries are validated but not embedded or installed.
RequiredTools *[]RequiredTool `json:"requiredTools,omitempty"`
}
ResourceManifest Canonical portability manifest for Agent Factory bundles. Required tools are validation-only PATH dependencies; bundled files carry portable content for restoration inside the factory boundary.
type ResourceRequirement ¶
ResourceRequirement defines model for ResourceRequirement.
type ResourceType ¶ added in v0.0.5
type ResourceType string
ResourceType Uppercase resource families supported by the public factory-config contract.
const ( ResourceTypeInvocationSlot ResourceType = "INVOCATION_SLOT" ResourceTypeModel ResourceType = "MODEL" ResourceTypeProviderQuota ResourceType = "PROVIDER_QUOTA" )
Defines values for ResourceType.
type ResourceUsage ¶
type ResourceUsage struct {
Available int `json:"available"`
Name string `json:"name"`
Total int `json:"total"`
}
ResourceUsage defines model for ResourceUsage.
type RunRequestEventPayload ¶
type RunRequestEventPayload struct {
Diagnostics *Diagnostics `json:"diagnostics,omitempty"`
// Factory Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.
Factory Factory `json:"factory"`
RecordedAt time.Time `json:"recordedAt"`
WallClock *WallClock `json:"wallClock,omitempty"`
}
RunRequestEventPayload defines model for RunRequestEventPayload.
type RunResponseEventPayload ¶
type RunResponseEventPayload struct {
Diagnostics *Diagnostics `json:"diagnostics,omitempty"`
Reason *string `json:"reason,omitempty"`
// State Lifecycle state of the running factory.
State *FactoryState `json:"state,omitempty"`
WallClock *WallClock `json:"wallClock,omitempty"`
}
RunResponseEventPayload defines model for RunResponseEventPayload.
type RunnerID ¶ added in v0.0.5
type RunnerID string
RunnerID Stable built-in runner identifiers supported by factory and workstation runner selection.
type RunnerSelectionSource ¶ added in v0.0.5
type RunnerSelectionSource string
RunnerSelectionSource Configuration layer that supplied the resolved built-in runner selection for a dispatch.
const ( RunnerSelectionSourceDefault RunnerSelectionSource = "default" RunnerSelectionSourceFactory RunnerSelectionSource = "factory" RunnerSelectionSourceLegacyProvider RunnerSelectionSource = "legacy_provider" RunnerSelectionSourceWorkstation RunnerSelectionSource = "workstation" )
Defines values for RunnerSelectionSource.
type SafeWorkDiagnostics ¶
type SafeWorkDiagnostics struct {
Provider *ProviderDiagnostic `json:"provider,omitempty"`
RenderedPrompt *RenderedPromptDiagnostic `json:"renderedPrompt,omitempty"`
}
SafeWorkDiagnostics Dashboard-facing execution diagnostics that omit raw prompts, command stdin, and command environment values.
type SaveCurrentFactoryBadRequest ¶ added in v0.0.5
type SaveCurrentFactoryBadRequest = ErrorResponse
SaveCurrentFactoryBadRequest defines model for SaveCurrentFactoryBadRequest.
type SaveCurrentFactoryBySessionIdJSONRequestBody ¶ added in v0.0.5
type SaveCurrentFactoryBySessionIdJSONRequestBody = SaveFactoryForSessionRequest
SaveCurrentFactoryBySessionIdJSONRequestBody defines body for SaveCurrentFactoryBySessionId for application/json ContentType.
type SaveCurrentFactoryConflict ¶ added in v0.0.5
type SaveCurrentFactoryConflict = ErrorResponse
SaveCurrentFactoryConflict defines model for SaveCurrentFactoryConflict.
type SaveFactoryForSessionRequest ¶ added in v0.0.5
type SaveFactoryForSessionRequest struct {
// Factory Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.
Factory Factory `json:"factory"`
// Mode Explicit save mode for session-scoped factory submission. Omitted mode on PUT /factory-sessions/{session_id}/factory defaults to REPLACE_CURRENT.
Mode *FactorySaveMode `json:"mode,omitempty"`
}
SaveFactoryForSessionRequest Session-scoped factory submission payload for PUT /factory-sessions/{session_id}/factory.
type ScriptExecutionOutcome ¶
type ScriptExecutionOutcome string
ScriptExecutionOutcome Result category returned by one public script execution boundary.
const ( ScriptExecutionOutcomeFailedExitCode ScriptExecutionOutcome = "FAILED_EXIT_CODE" ScriptExecutionOutcomeProcessError ScriptExecutionOutcome = "PROCESS_ERROR" ScriptExecutionOutcomeSucceeded ScriptExecutionOutcome = "SUCCEEDED" ScriptExecutionOutcomeTimedOut ScriptExecutionOutcome = "TIMED_OUT" )
Defines values for ScriptExecutionOutcome.
type ScriptFailureType ¶
type ScriptFailureType string
ScriptFailureType Stable failure classification for script responses without a normal process exit code.
const ( ScriptFailureTypeProcessError ScriptFailureType = "PROCESS_ERROR" ScriptFailureTypeTimeout ScriptFailureType = "TIMEOUT" )
Defines values for ScriptFailureType.
type ScriptRequestEventPayload ¶
type ScriptRequestEventPayload struct {
// Args Fully resolved command arguments passed to the script command runner.
Args []string `json:"args"`
// Attempt One-based script attempt number for this dispatch.
Attempt int `json:"attempt"`
// Command Concrete command name executed for this script attempt.
Command string `json:"command"`
DispatchId string `json:"dispatchId"`
// ScriptRequestId Stable identifier correlating this script request with its response.
ScriptRequestId string `json:"scriptRequestId"`
TransitionId string `json:"transitionId"`
}
ScriptRequestEventPayload Request details captured immediately before a script-backed worker invokes a concrete command. Raw environment values and raw stdin content are intentionally excluded from the public script event contract.
type ScriptResponseEventPayload ¶
type ScriptResponseEventPayload struct {
// Attempt One-based script attempt number for this dispatch.
Attempt int `json:"attempt"`
DispatchId string `json:"dispatchId"`
// DurationMillis Script execution duration in milliseconds.
DurationMillis int64 `json:"durationMillis"`
// ExitCode Process exit code when the command returned one.
ExitCode *int `json:"exitCode,omitempty"`
// FailureType Stable failure classification for script responses without a normal process exit code.
FailureType *ScriptFailureType `json:"failureType,omitempty"`
// Outcome Result category returned by one public script execution boundary.
Outcome ScriptExecutionOutcome `json:"outcome"`
// ScriptRequestId Identifier from the matching script request event.
ScriptRequestId string `json:"scriptRequestId"`
// Stderr Captured stderr text from the script execution boundary.
Stderr string `json:"stderr"`
// Stdout Captured stdout text from the script execution boundary.
Stdout string `json:"stdout"`
TransitionId string `json:"transitionId"`
}
ScriptResponseEventPayload Response details captured after a script-backed worker command returns or fails before a normal exit code. Raw environment values and raw stdin content are intentionally excluded from the public script event contract.
type ServerInterface ¶
type ServerInterface interface {
// Stream factory events
// (GET /events)
GetEvents(w http.ResponseWriter, r *http.Request)
// List live factory sessions
// (GET /factory-sessions)
ListFactorySessions(w http.ResponseWriter, r *http.Request)
// Open another live factory session
// (POST /factory-sessions)
OpenFactorySession(w http.ResponseWriter, r *http.Request)
// Close one live factory session
// (DELETE /factory-sessions/{session_id})
CloseFactorySession(w http.ResponseWriter, r *http.Request, sessionId string)
// Stream factory events for one session
// (GET /factory-sessions/{session_id}/events)
GetEventsBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID)
// Get current factory for one session
// (GET /factory-sessions/{session_id}/factory)
GetCurrentFactoryBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID)
// Save factory for one session
// (PUT /factory-sessions/{session_id}/factory)
SaveCurrentFactoryBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID)
// Get workstation prompt-template contract
// (GET /factory-sessions/{session_id}/factory/workstations/{workstation_name}/prompt-template-contract)
GetCurrentFactoryWorkstationPromptTemplateContractBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID, workstationName string)
// Validate workstation prompt template
// (POST /factory-sessions/{session_id}/factory/workstations/{workstation_name}/prompt-template-validation)
ValidateCurrentFactoryWorkstationPromptTemplateBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID, workstationName string)
// Get runtime status for one session
// (GET /factory-sessions/{session_id}/status)
GetStatusBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID)
// List work for one session
// (GET /factory-sessions/{session_id}/work)
ListWorkBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID, params ListWorkBySessionIdParams)
// Submit work for one session
// (POST /factory-sessions/{session_id}/work)
SubmitWorkBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID)
// Upsert work request for one session
// (PUT /factory-sessions/{session_id}/work-requests/{request_id})
UpsertWorkRequestBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID, requestId string)
// Stage one submit-work file for one session
// (POST /factory-sessions/{session_id}/work/staged-files)
StageSubmitWorkFileBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID)
// Get work for one session
// (GET /factory-sessions/{session_id}/work/{id})
GetWorkBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID, id WorkOrTokenID)
// Move work to another state for one session
// (POST /factory-sessions/{session_id}/work/{id}/move)
MoveWorkBySessionId(w http.ResponseWriter, r *http.Request, sessionId SessionID, id WorkOrTokenID)
// Validate factory definition
// (POST /factory-validations)
ValidateFactory(w http.ResponseWriter, r *http.Request)
// List discovered models
// (GET /models)
ListModels(w http.ResponseWriter, r *http.Request)
// Get one discovered model
// (GET /models/{model_name})
GetModel(w http.ResponseWriter, r *http.Request, modelName string)
// Invoke one discovered model directly
// (POST /models/{model_name}/invocations)
InvokeModel(w http.ResponseWriter, r *http.Request, modelName string)
// Pull local model assets into the managed cache
// (POST /models/{model_name}/pull)
PullModel(w http.ResponseWriter, r *http.Request, modelName string)
// Get provider session details
// (GET /provider-sessions/detail)
GetProviderSessionDetails(w http.ResponseWriter, r *http.Request, params GetProviderSessionDetailsParams)
// Get runtime status
// (GET /status)
GetStatus(w http.ResponseWriter, r *http.Request)
// List work
// (GET /work)
ListWork(w http.ResponseWriter, r *http.Request, params ListWorkParams)
// Submit work
// (POST /work)
SubmitWork(w http.ResponseWriter, r *http.Request)
// Upsert work request
// (PUT /work-requests/{request_id})
UpsertWorkRequest(w http.ResponseWriter, r *http.Request, requestId string)
// Stage one submit-work file
// (POST /work/staged-files)
StageSubmitWorkFile(w http.ResponseWriter, r *http.Request)
// Get work
// (GET /work/{id})
GetWork(w http.ResponseWriter, r *http.Request, id WorkOrTokenID)
// Move work to another state
// (POST /work/{id}/move)
MoveWork(w http.ResponseWriter, r *http.Request, id WorkOrTokenID)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) CloseFactorySession ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) CloseFactorySession(w http.ResponseWriter, r *http.Request)
CloseFactorySession operation middleware
func (*ServerInterfaceWrapper) GetCurrentFactoryBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetCurrentFactoryBySessionId(w http.ResponseWriter, r *http.Request)
GetCurrentFactoryBySessionId operation middleware
func (*ServerInterfaceWrapper) GetCurrentFactoryWorkstationPromptTemplateContractBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetCurrentFactoryWorkstationPromptTemplateContractBySessionId(w http.ResponseWriter, r *http.Request)
GetCurrentFactoryWorkstationPromptTemplateContractBySessionId operation middleware
func (*ServerInterfaceWrapper) GetEvents ¶
func (siw *ServerInterfaceWrapper) GetEvents(w http.ResponseWriter, r *http.Request)
GetEvents operation middleware
func (*ServerInterfaceWrapper) GetEventsBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetEventsBySessionId(w http.ResponseWriter, r *http.Request)
GetEventsBySessionId operation middleware
func (*ServerInterfaceWrapper) GetModel ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetModel(w http.ResponseWriter, r *http.Request)
GetModel operation middleware
func (*ServerInterfaceWrapper) GetProviderSessionDetails ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetProviderSessionDetails(w http.ResponseWriter, r *http.Request)
GetProviderSessionDetails operation middleware
func (*ServerInterfaceWrapper) GetStatus ¶
func (siw *ServerInterfaceWrapper) GetStatus(w http.ResponseWriter, r *http.Request)
GetStatus operation middleware
func (*ServerInterfaceWrapper) GetStatusBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetStatusBySessionId(w http.ResponseWriter, r *http.Request)
GetStatusBySessionId operation middleware
func (*ServerInterfaceWrapper) GetWork ¶
func (siw *ServerInterfaceWrapper) GetWork(w http.ResponseWriter, r *http.Request)
GetWork operation middleware
func (*ServerInterfaceWrapper) GetWorkBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) GetWorkBySessionId(w http.ResponseWriter, r *http.Request)
GetWorkBySessionId operation middleware
func (*ServerInterfaceWrapper) InvokeModel ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) InvokeModel(w http.ResponseWriter, r *http.Request)
InvokeModel operation middleware
func (*ServerInterfaceWrapper) ListFactorySessions ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) ListFactorySessions(w http.ResponseWriter, r *http.Request)
ListFactorySessions operation middleware
func (*ServerInterfaceWrapper) ListModels ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) ListModels(w http.ResponseWriter, r *http.Request)
ListModels operation middleware
func (*ServerInterfaceWrapper) ListWork ¶
func (siw *ServerInterfaceWrapper) ListWork(w http.ResponseWriter, r *http.Request)
ListWork operation middleware
func (*ServerInterfaceWrapper) ListWorkBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) ListWorkBySessionId(w http.ResponseWriter, r *http.Request)
ListWorkBySessionId operation middleware
func (*ServerInterfaceWrapper) MoveWork ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) MoveWork(w http.ResponseWriter, r *http.Request)
MoveWork operation middleware
func (*ServerInterfaceWrapper) MoveWorkBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) MoveWorkBySessionId(w http.ResponseWriter, r *http.Request)
MoveWorkBySessionId operation middleware
func (*ServerInterfaceWrapper) OpenFactorySession ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) OpenFactorySession(w http.ResponseWriter, r *http.Request)
OpenFactorySession operation middleware
func (*ServerInterfaceWrapper) PullModel ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) PullModel(w http.ResponseWriter, r *http.Request)
PullModel operation middleware
func (*ServerInterfaceWrapper) SaveCurrentFactoryBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) SaveCurrentFactoryBySessionId(w http.ResponseWriter, r *http.Request)
SaveCurrentFactoryBySessionId operation middleware
func (*ServerInterfaceWrapper) StageSubmitWorkFile ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) StageSubmitWorkFile(w http.ResponseWriter, r *http.Request)
StageSubmitWorkFile operation middleware
func (*ServerInterfaceWrapper) StageSubmitWorkFileBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) StageSubmitWorkFileBySessionId(w http.ResponseWriter, r *http.Request)
StageSubmitWorkFileBySessionId operation middleware
func (*ServerInterfaceWrapper) SubmitWork ¶
func (siw *ServerInterfaceWrapper) SubmitWork(w http.ResponseWriter, r *http.Request)
SubmitWork operation middleware
func (*ServerInterfaceWrapper) SubmitWorkBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) SubmitWorkBySessionId(w http.ResponseWriter, r *http.Request)
SubmitWorkBySessionId operation middleware
func (*ServerInterfaceWrapper) UpsertWorkRequest ¶
func (siw *ServerInterfaceWrapper) UpsertWorkRequest(w http.ResponseWriter, r *http.Request)
UpsertWorkRequest operation middleware
func (*ServerInterfaceWrapper) UpsertWorkRequestBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) UpsertWorkRequestBySessionId(w http.ResponseWriter, r *http.Request)
UpsertWorkRequestBySessionId operation middleware
func (*ServerInterfaceWrapper) ValidateCurrentFactoryWorkstationPromptTemplateBySessionId ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) ValidateCurrentFactoryWorkstationPromptTemplateBySessionId(w http.ResponseWriter, r *http.Request)
ValidateCurrentFactoryWorkstationPromptTemplateBySessionId operation middleware
func (*ServerInterfaceWrapper) ValidateFactory ¶ added in v0.0.5
func (siw *ServerInterfaceWrapper) ValidateFactory(w http.ResponseWriter, r *http.Request)
ValidateFactory operation middleware
type SortBy ¶ added in v0.0.5
type SortBy string
SortBy defines model for SortBy.
const (
SortByStateType SortBy = "state.type"
)
Defines values for SortBy.
type StageSubmitWorkFileBySessionIdJSONRequestBody ¶ added in v0.0.5
type StageSubmitWorkFileBySessionIdJSONRequestBody = StageSubmitWorkFileRequest
StageSubmitWorkFileBySessionIdJSONRequestBody defines body for StageSubmitWorkFileBySessionId for application/json ContentType.
type StageSubmitWorkFileJSONRequestBody ¶ added in v0.0.5
type StageSubmitWorkFileJSONRequestBody = StageSubmitWorkFileRequest
StageSubmitWorkFileJSONRequestBody defines body for StageSubmitWorkFile for application/json ContentType.
type StageSubmitWorkFileRequest ¶ added in v0.0.5
type StageSubmitWorkFileRequest struct {
// ContentBase64 Base64-encoded file payload to stage behind a backend-owned reference.
ContentBase64 string `json:"contentBase64"`
// FileName Browser-authored filename preserved for inline identification and staging.
FileName string `json:"fileName"`
// ItemType Supported dashboard submit-work item types for multimodal submission.
ItemType SubmitWorkItemType `json:"itemType"`
// MediaType Browser-authored MIME type preserved for validation and dispatch decisions.
MediaType string `json:"mediaType"`
}
StageSubmitWorkFileRequest defines model for StageSubmitWorkFileRequest.
type StageSubmitWorkFileResponse ¶ added in v0.0.5
type StageSubmitWorkFileResponse struct {
// FileName Browser-authored filename preserved for inline identification after staging.
FileName string `json:"fileName"`
// MediaType Browser-authored MIME type preserved for inline identification after staging.
MediaType string `json:"mediaType"`
// StagedFileRef Backend-owned staged file reference returned for later structured submit-work items.
StagedFileRef string `json:"stagedFileRef"`
// Url Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
Url SubmitWorkContentURLProperty `json:"url"`
}
StageSubmitWorkFileResponse defines model for StageSubmitWorkFileResponse.
type StateType ¶ added in v0.0.5
type StateType = WorkStateType
StateType Categories of work states. The factory runtime treats these categories differently for lifecycle tracking and metrics purposes. Initial: The work is waiting to be picked up by a workstation. Processing: The work has been partially processed, and is continuing through its lifecycle. Terminal: The work has completed successfully. Failed: The work has failed.
type StatusCategories ¶
type StatusCategories struct {
Failed int `json:"failed"`
Initial int `json:"initial"`
Processing int `json:"processing"`
Terminal int `json:"terminal"`
}
StatusCategories defines model for StatusCategories.
type StatusResponse ¶
type StatusResponse struct {
Categories StatusCategories `json:"categories"`
FactoryState string `json:"factoryState"`
Resources *[]ResourceUsage `json:"resources,omitempty"`
RuntimeStatus string `json:"runtimeStatus"`
TotalTokens int `json:"totalTokens"`
}
StatusResponse defines model for StatusResponse.
type SubmitRelation ¶
type SubmitRelation struct {
// RequiredState Required target state before the dependency can proceed.
RequiredState *string `json:"requiredState,omitempty"`
// TargetWorkId Target runtime work identifier for the relation.
TargetWorkId string `json:"targetWorkId"`
// Type Relationship category between two pieces of work.
Type RelationType `json:"type"`
}
SubmitRelation defines model for SubmitRelation.
type SubmitWorkAudioItem ¶ added in v0.0.5
type SubmitWorkAudioItem struct {
// FileName Browser-authored filename preserved for inline identification and validation.
FileName string `json:"fileName"`
// MediaType Browser-authored MIME type preserved for validation and dispatch decisions.
MediaType string `json:"mediaType"`
// StagedFileRef Backend-owned staged file reference preserved for later dispatch.
StagedFileRef string `json:"stagedFileRef"`
Type SubmitWorkItemType `json:"type"`
// Url Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
Url SubmitWorkContentURLProperty `json:"url"`
}
SubmitWorkAudioItem defines model for SubmitWorkAudioItem.
type SubmitWorkBySessionIdJSONRequestBody ¶ added in v0.0.5
type SubmitWorkBySessionIdJSONRequestBody = SubmitWorkRequest
SubmitWorkBySessionIdJSONRequestBody defines body for SubmitWorkBySessionId for application/json ContentType.
type SubmitWorkContentURLProperty ¶ added in v0.0.5
type SubmitWorkContentURLProperty = string
SubmitWorkContentURLProperty Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
type SubmitWorkDocumentItem ¶ added in v0.0.5
type SubmitWorkDocumentItem struct {
// FileName Browser-authored filename preserved for inline identification and validation.
FileName string `json:"fileName"`
// MediaType Browser-authored MIME type preserved for validation and dispatch decisions.
MediaType string `json:"mediaType"`
// StagedFileRef Backend-owned staged file reference preserved for later dispatch.
StagedFileRef string `json:"stagedFileRef"`
Type SubmitWorkItemType `json:"type"`
// Url Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
Url SubmitWorkContentURLProperty `json:"url"`
}
SubmitWorkDocumentItem defines model for SubmitWorkDocumentItem.
type SubmitWorkFileItemCommonFields ¶ added in v0.0.5
type SubmitWorkFileItemCommonFields struct {
// FileName Browser-authored filename preserved for inline identification and validation.
FileName *string `json:"fileName,omitempty"`
// MediaType Browser-authored MIME type preserved for validation and dispatch decisions.
MediaType *string `json:"mediaType,omitempty"`
// StagedFileRef Backend-owned staged file reference preserved for later dispatch.
StagedFileRef *string `json:"stagedFileRef,omitempty"`
// Url Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
Url SubmitWorkContentURLProperty `json:"url"`
}
SubmitWorkFileItemCommonFields defines model for SubmitWorkFileItemCommonFields.
type SubmitWorkImageItem ¶ added in v0.0.5
type SubmitWorkImageItem struct {
// FileName Browser-authored filename preserved for inline identification and validation.
FileName string `json:"fileName"`
// MediaType Browser-authored MIME type preserved for validation and dispatch decisions.
MediaType string `json:"mediaType"`
// StagedFileRef Backend-owned staged file reference preserved for later dispatch.
StagedFileRef string `json:"stagedFileRef"`
Type SubmitWorkItemType `json:"type"`
// Url Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
Url SubmitWorkContentURLProperty `json:"url"`
}
SubmitWorkImageItem defines model for SubmitWorkImageItem.
type SubmitWorkItem ¶ added in v0.0.5
type SubmitWorkItem struct {
// contains filtered or unexported fields
}
SubmitWorkItem One ordered dashboard-authored submit-work item.
func (SubmitWorkItem) AsSubmitWorkAudioItem ¶ added in v0.0.5
func (t SubmitWorkItem) AsSubmitWorkAudioItem() (SubmitWorkAudioItem, error)
AsSubmitWorkAudioItem returns the union data inside the SubmitWorkItem as a SubmitWorkAudioItem
func (SubmitWorkItem) AsSubmitWorkDocumentItem ¶ added in v0.0.5
func (t SubmitWorkItem) AsSubmitWorkDocumentItem() (SubmitWorkDocumentItem, error)
AsSubmitWorkDocumentItem returns the union data inside the SubmitWorkItem as a SubmitWorkDocumentItem
func (SubmitWorkItem) AsSubmitWorkImageItem ¶ added in v0.0.5
func (t SubmitWorkItem) AsSubmitWorkImageItem() (SubmitWorkImageItem, error)
AsSubmitWorkImageItem returns the union data inside the SubmitWorkItem as a SubmitWorkImageItem
func (SubmitWorkItem) AsSubmitWorkTextItem ¶ added in v0.0.5
func (t SubmitWorkItem) AsSubmitWorkTextItem() (SubmitWorkTextItem, error)
AsSubmitWorkTextItem returns the union data inside the SubmitWorkItem as a SubmitWorkTextItem
func (SubmitWorkItem) AsSubmitWorkVideoItem ¶ added in v0.0.5
func (t SubmitWorkItem) AsSubmitWorkVideoItem() (SubmitWorkVideoItem, error)
AsSubmitWorkVideoItem returns the union data inside the SubmitWorkItem as a SubmitWorkVideoItem
func (*SubmitWorkItem) FromSubmitWorkAudioItem ¶ added in v0.0.5
func (t *SubmitWorkItem) FromSubmitWorkAudioItem(v SubmitWorkAudioItem) error
FromSubmitWorkAudioItem overwrites any union data inside the SubmitWorkItem as the provided SubmitWorkAudioItem
func (*SubmitWorkItem) FromSubmitWorkDocumentItem ¶ added in v0.0.5
func (t *SubmitWorkItem) FromSubmitWorkDocumentItem(v SubmitWorkDocumentItem) error
FromSubmitWorkDocumentItem overwrites any union data inside the SubmitWorkItem as the provided SubmitWorkDocumentItem
func (*SubmitWorkItem) FromSubmitWorkImageItem ¶ added in v0.0.5
func (t *SubmitWorkItem) FromSubmitWorkImageItem(v SubmitWorkImageItem) error
FromSubmitWorkImageItem overwrites any union data inside the SubmitWorkItem as the provided SubmitWorkImageItem
func (*SubmitWorkItem) FromSubmitWorkTextItem ¶ added in v0.0.5
func (t *SubmitWorkItem) FromSubmitWorkTextItem(v SubmitWorkTextItem) error
FromSubmitWorkTextItem overwrites any union data inside the SubmitWorkItem as the provided SubmitWorkTextItem
func (*SubmitWorkItem) FromSubmitWorkVideoItem ¶ added in v0.0.5
func (t *SubmitWorkItem) FromSubmitWorkVideoItem(v SubmitWorkVideoItem) error
FromSubmitWorkVideoItem overwrites any union data inside the SubmitWorkItem as the provided SubmitWorkVideoItem
func (SubmitWorkItem) MarshalJSON ¶ added in v0.0.5
func (t SubmitWorkItem) MarshalJSON() ([]byte, error)
func (*SubmitWorkItem) MergeSubmitWorkAudioItem ¶ added in v0.0.5
func (t *SubmitWorkItem) MergeSubmitWorkAudioItem(v SubmitWorkAudioItem) error
MergeSubmitWorkAudioItem performs a merge with any union data inside the SubmitWorkItem, using the provided SubmitWorkAudioItem
func (*SubmitWorkItem) MergeSubmitWorkDocumentItem ¶ added in v0.0.5
func (t *SubmitWorkItem) MergeSubmitWorkDocumentItem(v SubmitWorkDocumentItem) error
MergeSubmitWorkDocumentItem performs a merge with any union data inside the SubmitWorkItem, using the provided SubmitWorkDocumentItem
func (*SubmitWorkItem) MergeSubmitWorkImageItem ¶ added in v0.0.5
func (t *SubmitWorkItem) MergeSubmitWorkImageItem(v SubmitWorkImageItem) error
MergeSubmitWorkImageItem performs a merge with any union data inside the SubmitWorkItem, using the provided SubmitWorkImageItem
func (*SubmitWorkItem) MergeSubmitWorkTextItem ¶ added in v0.0.5
func (t *SubmitWorkItem) MergeSubmitWorkTextItem(v SubmitWorkTextItem) error
MergeSubmitWorkTextItem performs a merge with any union data inside the SubmitWorkItem, using the provided SubmitWorkTextItem
func (*SubmitWorkItem) MergeSubmitWorkVideoItem ¶ added in v0.0.5
func (t *SubmitWorkItem) MergeSubmitWorkVideoItem(v SubmitWorkVideoItem) error
MergeSubmitWorkVideoItem performs a merge with any union data inside the SubmitWorkItem, using the provided SubmitWorkVideoItem
func (*SubmitWorkItem) UnmarshalJSON ¶ added in v0.0.5
func (t *SubmitWorkItem) UnmarshalJSON(b []byte) error
type SubmitWorkItemList ¶ added in v0.0.5
type SubmitWorkItemList = []SubmitWorkItem
SubmitWorkItemList Ordered dashboard-authored submit-work items preserved for one submission.
type SubmitWorkItemType ¶ added in v0.0.5
type SubmitWorkItemType string
SubmitWorkItemType Supported dashboard submit-work item types for multimodal submission.
const ( SubmitWorkItemTypeAudio SubmitWorkItemType = "audio" SubmitWorkItemTypeDocument SubmitWorkItemType = "document" SubmitWorkItemTypeImage SubmitWorkItemType = "image" SubmitWorkItemTypeText SubmitWorkItemType = "text" SubmitWorkItemTypeVideo SubmitWorkItemType = "video" )
Defines values for SubmitWorkItemType.
type SubmitWorkJSONRequestBody ¶
type SubmitWorkJSONRequestBody = SubmitWorkRequest
SubmitWorkJSONRequestBody defines body for SubmitWork for application/json ContentType.
type SubmitWorkRequest ¶
type SubmitWorkRequest struct {
// Content Ordered canonical content parts for one work item.
Content *WorkContent `json:"content,omitempty"`
// CurrentChainingTraceId Explicit chaining-trace identifier for the submitted work.
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
// Items Ordered dashboard-authored submit-work items preserved for one submission.
Items *SubmitWorkItemList `json:"items,omitempty"`
// Name Required authored name for this single-work submission.
Name string `json:"name"`
// Payload Opaque work payload forwarded as raw JSON.
Payload interface{} `json:"payload,omitempty"`
// Relations Optional token-level runtime relations preserved on the submitted work item.
Relations *[]SubmitRelation `json:"relations,omitempty"`
Tags *StringMap `json:"tags,omitempty"`
// TraceId Legacy trace identifier retained for compatibility; prefer currentChainingTraceId.
TraceId *string `json:"traceId,omitempty"`
// WorkTypeName Configured work type name from factory.json to submit to.
WorkTypeName string `json:"workTypeName"`
}
SubmitWorkRequest defines model for SubmitWorkRequest.
type SubmitWorkResponse ¶
type SubmitWorkResponse struct {
// Accepted False when the same requestId was already accepted (idempotent replay).
Accepted bool `json:"accepted"`
// Name Submitted work display name.
Name *string `json:"name,omitempty"`
// RequestId Stable request identifier assigned during normalization.
RequestId string `json:"requestId"`
// SessionId Factory session that accepted the submit (~default for POST /work).
SessionId *string `json:"sessionId,omitempty"`
// TraceId Trace identifier for the submitted work request batch.
TraceId string `json:"traceId"`
// WorkId Primary work identifier for single-work submits (batch-<requestId>-<name> when omitted).
WorkId *string `json:"workId,omitempty"`
// WorkTypeName Configured work type name for the submitted work.
WorkTypeName *string `json:"workTypeName,omitempty"`
}
SubmitWorkResponse defines model for SubmitWorkResponse.
type SubmitWorkTextItem ¶ added in v0.0.5
type SubmitWorkTextItem struct {
// Text Authored inline text preserved in item order.
Text string `json:"text"`
Type SubmitWorkItemType `json:"type"`
}
SubmitWorkTextItem Ordered inline text submission item.
type SubmitWorkVideoItem ¶ added in v0.0.5
type SubmitWorkVideoItem struct {
// FileName Browser-authored filename preserved for inline identification and validation.
FileName string `json:"fileName"`
// MediaType Browser-authored MIME type preserved for validation and dispatch decisions.
MediaType string `json:"mediaType"`
// StagedFileRef Backend-owned staged file reference preserved for later dispatch.
StagedFileRef string `json:"stagedFileRef"`
Type SubmitWorkItemType `json:"type"`
// Url Canonical content URL for the submitted file-backed item. Supported schemes are file://, http://, https://, and data:.
Url SubmitWorkContentURLProperty `json:"url"`
}
SubmitWorkVideoItem defines model for SubmitWorkVideoItem.
type TokenHistory ¶
type TokenHistory struct {
ConsecutiveFailures *IntegerMap `json:"consecutiveFailures,omitempty"`
LastError *string `json:"lastError,omitempty"`
PlaceVisits *IntegerMap `json:"placeVisits,omitempty"`
TotalVisits *IntegerMap `json:"totalVisits,omitempty"`
}
TokenHistory defines model for TokenHistory.
type TokenResponse ¶
type TokenResponse struct {
ChainingTraceDepth *int `json:"chainingTraceDepth,omitempty"`
// Content Ordered canonical content parts for one work item.
Content *WorkContent `json:"content,omitempty"`
CreatedAt time.Time `json:"createdAt"`
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
EnteredAt time.Time `json:"enteredAt"`
History *TokenHistory `json:"history,omitempty"`
Id string `json:"id"`
Name *string `json:"name,omitempty"`
PlaceId string `json:"placeId"`
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
Tags *StringMap `json:"tags,omitempty"`
TraceId string `json:"traceId"`
WorkId string `json:"workId"`
WorkType string `json:"workType"`
}
TokenResponse defines model for TokenResponse.
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type Transition ¶
type Transition struct {
// From Source workstation name.
From string `json:"from"`
// To Destination workstation name.
To string `json:"to"`
}
Transition defines model for Transition.
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error
type UpsertWorkRequestBySessionIdJSONRequestBody ¶ added in v0.0.5
type UpsertWorkRequestBySessionIdJSONRequestBody = WorkRequest
UpsertWorkRequestBySessionIdJSONRequestBody defines body for UpsertWorkRequestBySessionId for application/json ContentType.
type UpsertWorkRequestJSONRequestBody ¶
type UpsertWorkRequestJSONRequestBody = WorkRequest
UpsertWorkRequestJSONRequestBody defines body for UpsertWorkRequest for application/json ContentType.
type UpsertWorkRequestResponse ¶
type UpsertWorkRequestResponse struct {
RequestId string `json:"requestId"`
TraceId string `json:"traceId"`
Works []UpsertWorkRequestSubmittedWork `json:"works"`
}
UpsertWorkRequestResponse defines model for UpsertWorkRequestResponse.
type UpsertWorkRequestSubmittedWork ¶ added in v0.0.5
type UpsertWorkRequestSubmittedWork struct {
Name string `json:"name"`
WorkId string `json:"workId"`
WorkTypeName string `json:"workTypeName"`
}
UpsertWorkRequestSubmittedWork defines model for UpsertWorkRequestSubmittedWork.
type ValidateCurrentFactoryWorkstationPromptTemplateBySessionIdJSONRequestBody ¶ added in v0.0.5
type ValidateCurrentFactoryWorkstationPromptTemplateBySessionIdJSONRequestBody = PromptTemplateValidationRequest
ValidateCurrentFactoryWorkstationPromptTemplateBySessionIdJSONRequestBody defines body for ValidateCurrentFactoryWorkstationPromptTemplateBySessionId for application/json ContentType.
type ValidateFactoryJSONRequestBody ¶ added in v0.0.5
type ValidateFactoryJSONRequestBody = Factory
ValidateFactoryJSONRequestBody defines body for ValidateFactory for application/json ContentType.
type WallClock ¶
type WallClock struct {
FinishedAt *time.Time `json:"finishedAt,omitempty"`
StartedAt *time.Time `json:"startedAt,omitempty"`
}
WallClock defines model for WallClock.
type Work ¶
type Work struct {
// ChainingTraceDepth Current chaining depth for this work item when the runtime already knows its upstream lineage.
ChainingTraceDepth *int `json:"chainingTraceDepth,omitempty"`
// Content Ordered canonical content parts for one work item.
Content *WorkContent `json:"content,omitempty"`
// CurrentChainingTraceId Explicit chaining-trace identifier for this submitted work item.
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
// Name A human readable name for the work, not unique
Name string `json:"name"`
// Payload Opaque work payload forwarded as raw JSON, or a binary data, or whatever else.
Payload interface{} `json:"payload,omitempty"`
// PreviousChainingTraceIds Explicit predecessor chaining traces that directly caused this work item.
PreviousChainingTraceIds *[]string `json:"previousChainingTraceIds,omitempty"`
// Relations Current outbound relationships attached to this listed source work item when returned by read APIs.
Relations *[]Relation `json:"relations,omitempty"`
// RequestId Identifier for the original request that created this work, if applicable
RequestId *string `json:"requestId,omitempty"`
// State A lifecycle state that a work item can occupy inside one work type.
State *WorkState `json:"state,omitempty"`
Tags *StringMap `json:"tags,omitempty"`
// TraceId Legacy trace identifier retained for compatibility; prefer currentChainingTraceId.
TraceId *string `json:"traceId,omitempty"`
// WorkId Unique identifier for the work
WorkId *string `json:"workId,omitempty"`
// WorkTypeName Configured work type name from factory.json for this submitted work item.
WorkTypeName *string `json:"workTypeName,omitempty"`
}
Work A piece of work.
func (*Work) UnmarshalJSON ¶ added in v0.0.5
UnmarshalJSON accepts the legacy string state form for submitted or replayed work while keeping read responses on the structured WorkState shape.
type WorkAudioContentPart ¶ added in v0.0.5
type WorkAudioContentPart struct {
// ArtifactId Optional artifact identifier for externally materialized content.
ArtifactId *string `json:"artifactId,omitempty"`
// ContentType Optional MIME content type for file-backed or structured parts.
ContentType *string `json:"contentType,omitempty"`
// File Deprecated host-local file path. Use url instead. Legacy values may be normalized to url at ingest during migration.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
File *WorkContentDeprecatedFileProperty `json:"file,omitempty"`
// Label Optional caller-defined label for slot binding or diagnostics.
Label *string `json:"label,omitempty"`
// Metadata Optional metadata attached to one work content part.
Metadata *WorkContentMetadata `json:"metadata,omitempty"`
// Role Optional semantic role for model-operation authoring.
Role *string `json:"role,omitempty"`
// Slot Optional slot name used by model-operation binding selectors and diagnostics.
Slot *string `json:"slot,omitempty"`
Type WorkContentPartType `json:"type"`
// Url Canonical content reference for file-backed parts. Supported schemes are file://, http://, https://, and data:.
Url WorkContentURLProperty `json:"url"`
}
WorkAudioContentPart defines model for WorkAudioContentPart.
type WorkBinaryContentPart ¶ added in v0.0.5
type WorkBinaryContentPart struct {
// ArtifactId Optional artifact identifier for externally materialized content.
ArtifactId *string `json:"artifactId,omitempty"`
// ContentType Optional MIME content type for file-backed or structured parts.
ContentType *string `json:"contentType,omitempty"`
// File Deprecated host-local file path. Use url instead. Legacy values may be normalized to url at ingest during migration.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
File *WorkContentDeprecatedFileProperty `json:"file,omitempty"`
// Label Optional caller-defined label for slot binding or diagnostics.
Label *string `json:"label,omitempty"`
// Metadata Optional metadata attached to one work content part.
Metadata *WorkContentMetadata `json:"metadata,omitempty"`
// Role Optional semantic role for model-operation authoring.
Role *string `json:"role,omitempty"`
// Slot Optional slot name used by model-operation binding selectors and diagnostics.
Slot *string `json:"slot,omitempty"`
Type WorkContentPartType `json:"type"`
// Url Canonical content reference for file-backed parts. Supported schemes are file://, http://, https://, and data:.
Url WorkContentURLProperty `json:"url"`
}
WorkBinaryContentPart defines model for WorkBinaryContentPart.
type WorkContent ¶ added in v0.0.5
type WorkContent = []WorkContentPart
WorkContent Ordered canonical content parts for one work item.
type WorkContentCommonFields ¶ added in v0.0.5
type WorkContentCommonFields struct {
// ArtifactId Optional artifact identifier for externally materialized content.
ArtifactId *string `json:"artifactId,omitempty"`
// ContentType Optional MIME content type for file-backed or structured parts.
ContentType *string `json:"contentType,omitempty"`
// Label Optional caller-defined label for slot binding or diagnostics.
Label *string `json:"label,omitempty"`
// Metadata Optional metadata attached to one work content part.
Metadata *WorkContentMetadata `json:"metadata,omitempty"`
// Role Optional semantic role for model-operation authoring.
Role *string `json:"role,omitempty"`
// Slot Optional slot name used by model-operation binding selectors and diagnostics.
Slot *string `json:"slot,omitempty"`
}
WorkContentCommonFields defines model for WorkContentCommonFields.
type WorkContentDeprecatedFileProperty ¶ added in v0.0.5
type WorkContentDeprecatedFileProperty = string
WorkContentDeprecatedFileProperty Deprecated host-local file path. Use url instead. Legacy values may be normalized to url at ingest during migration.
type WorkContentMetadata ¶ added in v0.0.5
type WorkContentMetadata map[string]interface{}
WorkContentMetadata Optional metadata attached to one work content part.
type WorkContentPart ¶ added in v0.0.5
type WorkContentPart struct {
// contains filtered or unexported fields
}
WorkContentPart One ordered canonical content part on a work item.
func (WorkContentPart) AsWorkAudioContentPart ¶ added in v0.0.5
func (t WorkContentPart) AsWorkAudioContentPart() (WorkAudioContentPart, error)
AsWorkAudioContentPart returns the union data inside the WorkContentPart as a WorkAudioContentPart
func (WorkContentPart) AsWorkBinaryContentPart ¶ added in v0.0.5
func (t WorkContentPart) AsWorkBinaryContentPart() (WorkBinaryContentPart, error)
AsWorkBinaryContentPart returns the union data inside the WorkContentPart as a WorkBinaryContentPart
func (WorkContentPart) AsWorkImageContentPart ¶ added in v0.0.5
func (t WorkContentPart) AsWorkImageContentPart() (WorkImageContentPart, error)
AsWorkImageContentPart returns the union data inside the WorkContentPart as a WorkImageContentPart
func (WorkContentPart) AsWorkJsonContentPart ¶ added in v0.0.5
func (t WorkContentPart) AsWorkJsonContentPart() (WorkJsonContentPart, error)
AsWorkJsonContentPart returns the union data inside the WorkContentPart as a WorkJsonContentPart
func (WorkContentPart) AsWorkTextContentPart ¶ added in v0.0.5
func (t WorkContentPart) AsWorkTextContentPart() (WorkTextContentPart, error)
AsWorkTextContentPart returns the union data inside the WorkContentPart as a WorkTextContentPart
func (*WorkContentPart) FromWorkAudioContentPart ¶ added in v0.0.5
func (t *WorkContentPart) FromWorkAudioContentPart(v WorkAudioContentPart) error
FromWorkAudioContentPart overwrites any union data inside the WorkContentPart as the provided WorkAudioContentPart
func (*WorkContentPart) FromWorkBinaryContentPart ¶ added in v0.0.5
func (t *WorkContentPart) FromWorkBinaryContentPart(v WorkBinaryContentPart) error
FromWorkBinaryContentPart overwrites any union data inside the WorkContentPart as the provided WorkBinaryContentPart
func (*WorkContentPart) FromWorkImageContentPart ¶ added in v0.0.5
func (t *WorkContentPart) FromWorkImageContentPart(v WorkImageContentPart) error
FromWorkImageContentPart overwrites any union data inside the WorkContentPart as the provided WorkImageContentPart
func (*WorkContentPart) FromWorkJsonContentPart ¶ added in v0.0.5
func (t *WorkContentPart) FromWorkJsonContentPart(v WorkJsonContentPart) error
FromWorkJsonContentPart overwrites any union data inside the WorkContentPart as the provided WorkJsonContentPart
func (*WorkContentPart) FromWorkTextContentPart ¶ added in v0.0.5
func (t *WorkContentPart) FromWorkTextContentPart(v WorkTextContentPart) error
FromWorkTextContentPart overwrites any union data inside the WorkContentPart as the provided WorkTextContentPart
func (WorkContentPart) MarshalJSON ¶ added in v0.0.5
func (t WorkContentPart) MarshalJSON() ([]byte, error)
func (*WorkContentPart) MergeWorkAudioContentPart ¶ added in v0.0.5
func (t *WorkContentPart) MergeWorkAudioContentPart(v WorkAudioContentPart) error
MergeWorkAudioContentPart performs a merge with any union data inside the WorkContentPart, using the provided WorkAudioContentPart
func (*WorkContentPart) MergeWorkBinaryContentPart ¶ added in v0.0.5
func (t *WorkContentPart) MergeWorkBinaryContentPart(v WorkBinaryContentPart) error
MergeWorkBinaryContentPart performs a merge with any union data inside the WorkContentPart, using the provided WorkBinaryContentPart
func (*WorkContentPart) MergeWorkImageContentPart ¶ added in v0.0.5
func (t *WorkContentPart) MergeWorkImageContentPart(v WorkImageContentPart) error
MergeWorkImageContentPart performs a merge with any union data inside the WorkContentPart, using the provided WorkImageContentPart
func (*WorkContentPart) MergeWorkJsonContentPart ¶ added in v0.0.5
func (t *WorkContentPart) MergeWorkJsonContentPart(v WorkJsonContentPart) error
MergeWorkJsonContentPart performs a merge with any union data inside the WorkContentPart, using the provided WorkJsonContentPart
func (*WorkContentPart) MergeWorkTextContentPart ¶ added in v0.0.5
func (t *WorkContentPart) MergeWorkTextContentPart(v WorkTextContentPart) error
MergeWorkTextContentPart performs a merge with any union data inside the WorkContentPart, using the provided WorkTextContentPart
func (*WorkContentPart) UnmarshalJSON ¶ added in v0.0.5
func (t *WorkContentPart) UnmarshalJSON(b []byte) error
type WorkContentPartType ¶ added in v0.0.5
type WorkContentPartType string
WorkContentPartType Supported canonical work content part types. Legacy lowercase text and image values remain accepted for backward compatibility.
const ( WorkContentPartTypeAudio WorkContentPartType = "AUDIO" WorkContentPartTypeBinary WorkContentPartType = "BINARY" WorkContentPartTypeImage WorkContentPartType = "image" WorkContentPartTypeImageUpper WorkContentPartType = "IMAGE" WorkContentPartTypeJSON WorkContentPartType = "JSON" WorkContentPartTypeText WorkContentPartType = "text" WorkContentPartTypeTextUpper WorkContentPartType = "TEXT" )
Defines values for WorkContentPartType.
type WorkContentURLProperty ¶ added in v0.0.5
type WorkContentURLProperty = string
WorkContentURLProperty Canonical content reference for file-backed parts. Supported schemes are file://, http://, https://, and data:.
type WorkDiagnostics ¶
type WorkDiagnostics struct {
Command *CommandDiagnostic `json:"command,omitempty"`
Metadata *StringMap `json:"metadata,omitempty"`
Panic *PanicDiagnostic `json:"panic,omitempty"`
Provider *ProviderDiagnostic `json:"provider,omitempty"`
RenderedPrompt *RenderedPromptDiagnostic `json:"renderedPrompt,omitempty"`
}
WorkDiagnostics defines model for WorkDiagnostics.
type WorkFailureFamily ¶ added in v0.0.5
type WorkFailureFamily string
WorkFailureFamily Stable machine-readable failure family used to decide retry and routing behavior for failed work.
const ( WorkFailureFamilyRetryable WorkFailureFamily = "retryable" WorkFailureFamilyTerminal WorkFailureFamily = "terminal" WorkFailureFamilyThrottle WorkFailureFamily = "throttle" )
Defines values for WorkFailureFamily.
type WorkFailureType ¶ added in v0.0.5
type WorkFailureType string
WorkFailureType Stable machine-readable failure type used to classify failed work across providers and runtimes.
const ( WorkFailureTypeAuthFailure WorkFailureType = "auth_failure" WorkFailureTypeInternalServerError WorkFailureType = "internal_server_error" WorkFailureTypeMisconfigured WorkFailureType = "misconfigured" WorkFailureTypePermanentBadRequest WorkFailureType = "permanent_bad_request" WorkFailureTypeThrottled WorkFailureType = "throttled" WorkFailureTypeTimeout WorkFailureType = "timeout" WorkFailureTypeUnknown WorkFailureType = "unknown" )
Defines values for WorkFailureType.
type WorkImageContentPart ¶ added in v0.0.5
type WorkImageContentPart struct {
// ArtifactId Optional artifact identifier for externally materialized content.
ArtifactId *string `json:"artifactId,omitempty"`
// ContentType Optional MIME content type for file-backed or structured parts.
ContentType *string `json:"contentType,omitempty"`
// File Deprecated host-local file path. Use url instead. Legacy values may be normalized to url at ingest during migration.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
File *WorkContentDeprecatedFileProperty `json:"file,omitempty"`
// Label Optional caller-defined label for slot binding or diagnostics.
Label *string `json:"label,omitempty"`
// Metadata Optional metadata attached to one work content part.
Metadata *WorkContentMetadata `json:"metadata,omitempty"`
// Role Optional semantic role for model-operation authoring.
Role *string `json:"role,omitempty"`
// Slot Optional slot name used by model-operation binding selectors and diagnostics.
Slot *string `json:"slot,omitempty"`
Type WorkContentPartType `json:"type"`
// Url Canonical content reference for file-backed parts. Supported schemes are file://, http://, https://, and data:.
Url WorkContentURLProperty `json:"url"`
}
WorkImageContentPart defines model for WorkImageContentPart.
type WorkJsonContentPart ¶ added in v0.0.5
type WorkJsonContentPart struct {
// ArtifactId Optional artifact identifier for externally materialized content.
ArtifactId *string `json:"artifactId,omitempty"`
// ContentType Optional MIME content type for file-backed or structured parts.
ContentType *string `json:"contentType,omitempty"`
// Json Arbitrary JSON value preserved in canonical part order.
Json interface{} `json:"json"`
// Label Optional caller-defined label for slot binding or diagnostics.
Label *string `json:"label,omitempty"`
// Metadata Optional metadata attached to one work content part.
Metadata *WorkContentMetadata `json:"metadata,omitempty"`
// Role Optional semantic role for model-operation authoring.
Role *string `json:"role,omitempty"`
// Slot Optional slot name used by model-operation binding selectors and diagnostics.
Slot *string `json:"slot,omitempty"`
Type WorkContentPartType `json:"type"`
}
WorkJsonContentPart defines model for WorkJsonContentPart.
type WorkListName ¶ added in v0.0.5
type WorkListName = string
WorkListName defines model for WorkListName.
type WorkListTraceId ¶ added in v0.0.5
type WorkListTraceId = string
WorkListTraceId defines model for WorkListTraceId.
type WorkListWorkTypeName ¶ added in v0.0.5
type WorkListWorkTypeName = string
WorkListWorkTypeName defines model for WorkListWorkTypeName.
type WorkMetrics ¶
type WorkMetrics struct {
Cost *float64 `json:"cost,omitempty"`
DurationMillis *int64 `json:"durationMillis,omitempty"`
RetryCount *int `json:"retryCount,omitempty"`
}
WorkMetrics defines model for WorkMetrics.
type WorkOutcome ¶
type WorkOutcome string
WorkOutcome Result category returned by a workstation execution.
const ( WorkOutcomeAccepted WorkOutcome = "ACCEPTED" WorkOutcomeContinue WorkOutcome = "CONTINUE" WorkOutcomeFailed WorkOutcome = "FAILED" WorkOutcomeRejected WorkOutcome = "REJECTED" )
Defines values for WorkOutcome.
type WorkRequest ¶
type WorkRequest struct {
// CurrentChainingTraceId Optional default chaining-trace identifier applied to submitted work items that omit it.
CurrentChainingTraceId *string `json:"currentChainingTraceId,omitempty"`
// Relations Relationships between various work items.
Relations *[]Relation `json:"relations,omitempty"`
// RequestId Stable client-provided request identifier used for idempotent batch submission.
RequestId string `json:"requestId"`
// Type Kind of work request accepted by the factory.
Type WorkRequestType `json:"type"`
// Works A batch of work items to be submitted together.
Works *[]Work `json:"works,omitempty"`
}
WorkRequest defines model for WorkRequest.
type WorkRequestEventPayload ¶
type WorkRequestEventPayload struct {
ParentLineage *[]string `json:"parentLineage,omitempty"`
Relations *[]Relation `json:"relations,omitempty"`
Source *string `json:"source,omitempty"`
// Type Kind of work request accepted by the factory.
Type WorkRequestType `json:"type"`
Works *[]Work `json:"works,omitempty"`
}
WorkRequestEventPayload Normalized work request entering the factory. Single-work submissions accepted by POST /work are converted into this one-work request shape before an event is emitted.
type WorkRequestType ¶
type WorkRequestType string
WorkRequestType Kind of work request accepted by the factory.
const (
WorkRequestTypeFactoryRequestBatch WorkRequestType = "FACTORY_REQUEST_BATCH"
)
Defines values for WorkRequestType.
type WorkState ¶
type WorkState struct {
// Name Customer-authored state name referenced by workstation inputs and outputs.
Name string `json:"name"`
// Type Categories of work states. The factory runtime treats these categories differently for lifecycle tracking and metrics purposes. Initial: The work is waiting to be picked up by a workstation. Processing: The work has been partially processed, and is continuing through its lifecycle. Terminal: The work has completed successfully. Failed: The work has failed.
Type WorkStateType `json:"type"`
}
WorkState A lifecycle state that a work item can occupy inside one work type.
type WorkStateChangeEventPayload ¶ added in v0.0.5
type WorkStateChangeEventPayload struct {
// FromPlaceId Marking place identifier before the move.
FromPlaceId string `json:"fromPlaceId"`
// FromState Authored state name before the move.
FromState string `json:"fromState"`
// Reason Optional human-readable reason for the move.
Reason *string `json:"reason,omitempty"`
// Source Origin of a WORK_STATE_CHANGE event.
Source WorkStateChangeSource `json:"source"`
// ToPlaceId Marking place identifier after the move.
ToPlaceId string `json:"toPlaceId"`
// ToState Authored state name after the move.
ToState string `json:"toState"`
// TriggerWorkId Optional work identifier that triggered a cascade move.
TriggerWorkId *string `json:"triggerWorkId,omitempty"`
WorkId string `json:"workId"`
WorkTypeName string `json:"workTypeName"`
}
WorkStateChangeEventPayload Canonical work marking position change. Operator moves use source api or cli; automatic cascade propagation uses cascading-failure. FactoryEvent.context carries workIds and optional requestId for operator idempotency.
type WorkStateChangeSource ¶ added in v0.0.5
type WorkStateChangeSource string
WorkStateChangeSource Origin of a WORK_STATE_CHANGE event.
const ( WorkStateChangeSourceAPI WorkStateChangeSource = "api" WorkStateChangeSourceCLI WorkStateChangeSource = "cli" WorkStateChangeSourceCascadingFailure WorkStateChangeSource = "cascading-failure" )
Defines values for WorkStateChangeSource.
type WorkStateType ¶
type WorkStateType string
WorkStateType Categories of work states. The factory runtime treats these categories differently for lifecycle tracking and metrics purposes. Initial: The work is waiting to be picked up by a workstation. Processing: The work has been partially processed, and is continuing through its lifecycle. Terminal: The work has completed successfully. Failed: The work has failed.
const ( WorkStateTypeFAILED WorkStateType = "FAILED" WorkStateTypeINITIAL WorkStateType = "INITIAL" WorkStateTypePROCESSING WorkStateType = "PROCESSING" WorkStateTypeTERMINAL WorkStateType = "TERMINAL" )
Defines values for WorkStateType.
type WorkTextContentPart ¶ added in v0.0.5
type WorkTextContentPart struct {
// ArtifactId Optional artifact identifier for externally materialized content.
ArtifactId *string `json:"artifactId,omitempty"`
// ContentType Optional MIME content type for file-backed or structured parts.
ContentType *string `json:"contentType,omitempty"`
// Label Optional caller-defined label for slot binding or diagnostics.
Label *string `json:"label,omitempty"`
// Metadata Optional metadata attached to one work content part.
Metadata *WorkContentMetadata `json:"metadata,omitempty"`
// Role Optional semantic role for model-operation authoring.
Role *string `json:"role,omitempty"`
// Slot Optional slot name used by model-operation binding selectors and diagnostics.
Slot *string `json:"slot,omitempty"`
// Text Inline text content preserved in canonical part order.
Text string `json:"text"`
Type WorkContentPartType `json:"type"`
}
WorkTextContentPart defines model for WorkTextContentPart.
type WorkType ¶
type WorkType struct {
// HandlingBehavior Optional CLI routing markers for this work type. Factories used with you run --factory must declare handlingBehavior DEFAULT on exactly one work type.
HandlingBehavior *[]WorkTypeHandlingBehavior `json:"handlingBehavior,omitempty"`
// Name Customer-authored work type name referenced by workstation inputs, outputs, and submitted work.
Name string `json:"name"`
// States Lifecycle states available for work items of this type.
States []WorkState `json:"states"`
}
WorkType A named category of work that can move through the factory. Each work type declares the lifecycle states its work items can occupy.
type WorkTypeHandlingBehavior ¶ added in v0.0.5
type WorkTypeHandlingBehavior string
WorkTypeHandlingBehavior Declares how the CLI should route simplified one-shot prompt submissions for this work type. DEFAULT marks the single work type that receives positional prompts from you run --factory.
const (
WorkTypeHandlingBehaviorDefault WorkTypeHandlingBehavior = "DEFAULT"
)
Defines values for WorkTypeHandlingBehavior.
type Worker ¶
type Worker struct {
// Args Additional command arguments passed to the configured command.
Args *[]string `json:"args,omitempty"`
// Auth Hosted-worker authentication contract. V1 hosted workers accept only secret references rather than inline credentials or OAuth-style fields.
Auth *HostedWorkerAuth `json:"auth,omitempty"`
// Body Inline worker instructions or script body when the worker is authored directly in factory config.
Body *string `json:"body,omitempty"`
// Command Command to execute when this worker runs through a command or script provider.
Command *string `json:"command,omitempty"`
// ExecutorProvider Concrete worker-provider wrappers supported by the public factory-config contract.
ExecutorProvider *WorkerProvider `json:"executorProvider,omitempty"`
// Linear Provider-specific poller configuration for the built-in hosted Linear worker.
Linear *HostedLinearWorkerConfig `json:"linear,omitempty"`
// Model Model identifier to request from the configured model provider when this worker uses model execution.
Model *string `json:"model,omitempty"`
// ModelLocality Provider locality for a model worker capability declaration.
ModelLocality *WorkerModelLocality `json:"modelLocality,omitempty"`
// ModelProvider Canonical model-provider identifiers supported by model workers in factory config.
ModelProvider *WorkerModelProvider `json:"modelProvider,omitempty"`
// Name Worker name referenced by Workstation.worker.
Name string `json:"name"`
// OpenCodeAgent Optional OpenCode agent profile name for model workers that dispatch through the OpenCode runner. When set, OpenCode dispatches invoke `opencode run --agent <name>`. Discover agent names with `opencode agent list` (see https://opencode.ai/docs/cli/).
OpenCodeAgent *string `json:"openCodeAgent,omitempty"`
// Operations Provider-agnostic model operations that this worker can execute, including named input and output slots.
Operations *[]ModelOperation `json:"operations,omitempty"`
// Provider Built-in repository-owned hosted worker providers supported by the public factory-config contract.
Provider *HostedWorkerProvider `json:"provider,omitempty"`
// Resources Resource capacity this worker requires before it can be dispatched.
Resources *[]ResourceRequirement `json:"resources,omitempty"`
// SkipPermissions When true, bypasses permission checks for providers that support permission gating.
SkipPermissions *bool `json:"skipPermissions,omitempty"`
// StopToken Marker that tells model-oriented workers where to stop generated output when the provider supports it.
StopToken *string `json:"stopToken,omitempty"`
// Timeout Optional Go duration that caps one worker execution attempt.
Timeout *string `json:"timeout,omitempty"`
// Type Worker implementation families supported by the public factory-config contract.
Type *WorkerType `json:"type,omitempty"`
}
Worker A reusable worker definition that tells the factory how a workstation should execute work, such as through a model-backed agent or a script.
type WorkerModelLocality ¶ added in v0.0.5
type WorkerModelLocality string
WorkerModelLocality Provider locality for a model worker capability declaration.
const ( WorkerModelLocalityCloud WorkerModelLocality = "CLOUD" WorkerModelLocalityLocal WorkerModelLocality = "LOCAL" )
Defines values for WorkerModelLocality.
type WorkerModelProvider ¶
type WorkerModelProvider string
WorkerModelProvider Canonical model-provider identifiers supported by model workers in factory config.
const ( WorkerModelProviderClaude WorkerModelProvider = "CLAUDE" WorkerModelProviderCodex WorkerModelProvider = "CODEX" WorkerModelProviderCursor WorkerModelProvider = "CURSOR" WorkerModelProviderGemini WorkerModelProvider = "GEMINI" WorkerModelProviderKiro WorkerModelProvider = "KIRO" WorkerModelProviderOpenCode WorkerModelProvider = "OPENCODE" )
Defines values for WorkerModelProvider.
type WorkerProvider ¶
type WorkerProvider string
WorkerProvider Concrete worker-provider wrappers supported by the public factory-config contract.
const (
WorkerProviderScriptWrap WorkerProvider = "SCRIPT_WRAP"
)
Defines values for WorkerProvider.
type WorkerType ¶
type WorkerType string
WorkerType Worker implementation families supported by the public factory-config contract.
const ( WorkerTypeHostedWorker WorkerType = "HOSTED_WORKER" WorkerTypeModelWorker WorkerType = "MODEL_WORKER" WorkerTypeScriptWorker WorkerType = "SCRIPT_WORKER" )
Defines values for WorkerType.
type Workstation ¶
type Workstation struct {
// Behavior Scheduling kind for a workstation, which determines how the engine schedules and dispatches work to it. Standard workstations are scheduled as soon as their inputs are ready, and can have multiple work items in-flight at the same time. Repeater workstations are triggered whenever their inputs change, and will reloop the outputs on rejection back to the initial place. Cron workstations create internal time work and dispatch their configured worker when time and input guards are satisfied. Poller workstations bind a poller-capable worker that the service runtime supervises as a long-lived ingress loop.
Behavior *WorkstationKind `json:"behavior,omitempty"`
// Body Inline workstation instructions or script body when authored directly in factory config.
Body *string `json:"body,omitempty"`
// ClassificationRoutes Explicit label-to-destination routing used only by CLASSIFIER_WORKSTATION definitions. Each route must declare a unique non-empty label and one or more outputs.
ClassificationRoutes *[]ClassificationRoute `json:"classificationRoutes,omitempty"`
// CopyReferencedScripts Copy supported referenced script files into the expanded workstation layout when config expand runs.
CopyReferencedScripts *bool `json:"copyReferencedScripts,omitempty"`
// Cron Trigger timing for cron workstations. Cron workstations use a schedule expression; interval triggers are not supported.
Cron *WorkstationCron `json:"cron,omitempty"`
Env *StringMap `json:"env,omitempty"`
// Guards Guarded loop breakers should use `VISIT_COUNT` guards here with a `LOGICAL_MOVE` workstation instead of top-level exhaustion rules.
Guards *[]Guard `json:"guards,omitempty"`
// Id Optional stable identifier for this workstation in serialized runtime and replay payloads.
Id *string `json:"id,omitempty"`
// Inputs Work states this workstation can consume before it dispatches.
Inputs []WorkstationIO `json:"inputs"`
// Limits Retry and execution ceilings applied to one workstation definition.
Limits *WorkstationLimits `json:"limits,omitempty"`
// Name Customer-authored workstation name used by guards, diagnostics, and authored references.
Name string `json:"name"`
// OnContinue Optional destination emitted when the workstation makes partial progress and should continue iterating. Classifier workstations must not declare onContinue.
OnContinue *[]WorkstationIO `json:"onContinue,omitempty"`
// OnFailure Optional destination emitted when the workstation fails permanently.
OnFailure *[]WorkstationIO `json:"onFailure,omitempty"`
// OnRejection Optional destination emitted when the worker rejects the current work without a hard failure. Classifier workstations must not declare onRejection.
OnRejection *[]WorkstationIO `json:"onRejection,omitempty"`
// OpenCodeAgent Optional OpenCode agent profile override for this workstation. When set, overrides the worker default for OpenCode dispatches and invokes `opencode run --agent <name>`. Discover agent names with `opencode agent list` (see https://opencode.ai/docs/cli/).
OpenCodeAgent *string `json:"openCodeAgent,omitempty"`
// Operation Uppercase public operation identifier such as `TTS`, `ASR`, or `EMBED`.
Operation *ModelOperationName `json:"operation,omitempty"`
// OperationBindings Optional workstation-authored slot bindings that resolve operation inputs from runtime content or static config content.
OperationBindings *[]WorkstationOperationBinding `json:"operationBindings,omitempty"`
// OutputSchema JSON schema string used to validate or parse structured model output when configured.
OutputSchema *string `json:"outputSchema,omitempty"`
// Outputs Work states emitted after a non-classifier workstation succeeds. Classifier workstations must use classificationRoutes instead of normal success outputs.
Outputs *[]WorkstationIO `json:"outputs,omitempty"`
// PromptFile Path to a prompt template file loaded for model-oriented workstation execution.
PromptFile *string `json:"promptFile,omitempty"`
// Resources Resource capacity this workstation consumes while one dispatch is in flight.
Resources *[]ResourceRequirement `json:"resources,omitempty"`
// Runner Stable built-in runner identifiers supported by factory and workstation runner selection.
Runner *RunnerID `json:"runner,omitempty"`
// StopWords Stop words authored on the topology entry for model-oriented dispatches.
StopWords *[]string `json:"stopWords,omitempty"`
// Type Runtime workstation implementation types supported by the public factory-config contract.
Type *WorkstationType `json:"type,omitempty"`
// Worker Name of a worker declared in the workers list.
Worker string `json:"worker"`
// WorkingDirectory Go template resolved from token tags at dispatch time.
WorkingDirectory *string `json:"workingDirectory,omitempty"`
// Worktree Go template resolved and passed as the worktree path to CLI dispatchers.
Worktree *string `json:"worktree,omitempty"`
}
Workstation A processing step in the factory graph. Workstations consume authored work states, run a worker or logical move, and emit the next work states.
type WorkstationCron ¶
type WorkstationCron struct {
// ExpiryWindow Positive Go duration after due_at before a stale cron time token expires and can be consumed by the system expiry transition. Defaults to the duration until the next scheduled cron fire when omitted.
ExpiryWindow *string `json:"expiryWindow,omitempty"`
// Jitter Non-negative Go duration used as the maximum deterministic delay added to scheduled time tokens. Defaults to "0s".
Jitter *string `json:"jitter,omitempty"`
// Schedule Standard five-field cron expression used to produce internal time work while the factory service is running.
Schedule string `json:"schedule"`
// TriggerAtStart When true, service startup submits one immediate internal time work item before waiting for the next scheduled cron fire.
TriggerAtStart *bool `json:"triggerAtStart,omitempty"`
}
WorkstationCron Trigger timing for cron workstations. Cron workstations use a schedule expression; interval triggers are not supported.
type WorkstationIO ¶
type WorkstationIO struct {
// Guards Per-input guards that must pass before this specific input can be used.
Guards *[]Guard `json:"guards,omitempty"`
// State Name of the work state consumed or emitted for the referenced work type.
State string `json:"state"`
// WorkType Name of the work type consumed or emitted at this edge of the workstation.
WorkType string `json:"workType"`
}
WorkstationIO One authored work-state reference consumed or emitted by a workstation.
type WorkstationKind ¶
type WorkstationKind string
WorkstationKind Scheduling kind for a workstation, which determines how the engine schedules and dispatches work to it. Standard workstations are scheduled as soon as their inputs are ready, and can have multiple work items in-flight at the same time. Repeater workstations are triggered whenever their inputs change, and will reloop the outputs on rejection back to the initial place. Cron workstations create internal time work and dispatch their configured worker when time and input guards are satisfied. Poller workstations bind a poller-capable worker that the service runtime supervises as a long-lived ingress loop.
const ( WorkstationKindCron WorkstationKind = "CRON" WorkstationKindPoller WorkstationKind = "POLLER" WorkstationKindRepeater WorkstationKind = "REPEATER" WorkstationKindStandard WorkstationKind = "STANDARD" )
Defines values for WorkstationKind.
type WorkstationLimits ¶
type WorkstationLimits struct {
// MaxExecutionTime Go duration limit for one dispatch attempt before it times out.
MaxExecutionTime *string `json:"maxExecutionTime,omitempty"`
// MaxRetries Maximum number of retry attempts after a failed dispatch before the workstation gives up.
MaxRetries *int `json:"maxRetries,omitempty"`
}
WorkstationLimits Retry and execution ceilings applied to one workstation definition.
type WorkstationOperationBinding ¶ added in v0.0.5
type WorkstationOperationBinding struct {
// Config Ordered canonical content parts for one work item.
Config *WorkContent `json:"config,omitempty"`
// DefaultContent Ordered canonical content parts for one work item.
DefaultContent *WorkContent `json:"defaultContent,omitempty"`
// Selector Selector fields used to resolve one content part from ordered runtime input.
Selector *WorkstationOperationBindingSelector `json:"selector,omitempty"`
// Slot Stable input slot name declared by the worker operation.
Slot string `json:"slot"`
}
WorkstationOperationBinding One workstation-authored binding for a provider-agnostic model-operation input slot.
type WorkstationOperationBindingSelector ¶ added in v0.0.5
type WorkstationOperationBindingSelector struct {
// Label Match a content part by its label field.
Label *string `json:"label,omitempty"`
// Role Match a content part by its role field.
Role *string `json:"role,omitempty"`
// Slot Match a content part by its authored slot field.
Slot *string `json:"slot,omitempty"`
// Type Uppercase content-part categories supported by worker model-operation capability slots.
Type *ModelOperationContentType `json:"type,omitempty"`
}
WorkstationOperationBindingSelector Selector fields used to resolve one content part from ordered runtime input.
type WorkstationType ¶
type WorkstationType string
WorkstationType Runtime workstation implementation types supported by the public factory-config contract.
const ( WorkstationTypeClassifierWorkstation WorkstationType = "CLASSIFIER_WORKSTATION" WorkstationTypeLogicalMove WorkstationType = "LOGICAL_MOVE" WorkstationTypeModelInvoke WorkstationType = "MODEL_INVOKE" WorkstationTypeModelWorkstation WorkstationType = "MODEL_WORKSTATION" )
Defines values for WorkstationType.