Skip to main content

Module api

Module api 

Source
Expand description

sdk/pluginapi request and response schemas, field for field. Wire names are the Go field names unless Go declares a json tag. Host-only members (HTTPClient, handler interfaces) are not part of the wire format and are left out.

Structs§

AuthData
AuthLoginPollRequest
AuthLoginPollResponse
AuthLoginStartRequest
AuthLoginStartResponse
AuthModelRequest
AuthParseRequest
AuthParseResponse
AuthRefreshRequest
AuthRefreshResponse
CommandLineExecutionRequest
CommandLineExecutionResponse
CommandLineFlag
CommandLineFlagValue
CommandLineRegistrationRequest
CommandLineRegistrationResponse
ConfigField
ExecutorHttpRequest
ExecutorHttpResponse
ExecutorRequest
ExecutorResponse
ExecutorStreamChunk
pluginapi.ExecutorStreamChunk; see HttpStreamChunk for Err.
FrontendAuthRequest
FrontendAuthResponse
HostAffinityLookupRequest
HostAffinityLookupResponse
HostAuthFileEntry
HostAuthGetRequest
HostAuthGetResponse
HostAuthGetRuntimeResponse
HostAuthSaveRequest
HostAuthSaveResponse
HostConfigSummary
HostModelExecutionRequest
HostModelExecutionResponse
HostModelStreamCloseRequest
HostModelStreamReadRequest
HostModelStreamReadResponse
HostModelStreamResponse
HostRecentRequestEntry
HttpRequest
HttpResponse
HttpStreamChunk
pluginapi.HTTPStreamChunk. Err is a Go error interface: it encodes as {} or null and never decodes back, so only the payload crosses the wire.
HttpWireProfile
ManagementRegistrationRequest
ManagementRegistrationResponse
The management.register result (rpcManagementRegistrationResponse).
ManagementRequest
ManagementResponse
ManagementRoute
pluginapi.ManagementRoute without its host-side Handler.
ModelAlias
ModelInfo
ModelRegistrationRequest
ModelRegistrationResponse
ModelResponse
ModelRouteRequest
ModelRouteResponse
PayloadResponse
PluginMetadata
pluginapi.Metadata.
QuotaBucket
QuotaBucketAlt
QuotaDescribeRequest
QuotaDescribeResponse
QuotaFetchRequest
QuotaFetchResponse
QuotaFetchResponseAlt
QuotaGroup
QuotaGroupAlt
QuotaMetric
QuotaResetRequest
QuotaResetResponse
QuotaSubscription
QuotaSubscriptionAlt
RequestCompletion
RequestInterceptRequest
RequestInterceptResponse
RequestTransformRequest
ResourceRoute
pluginapi.ResourceRoute without its host-side Handler.
ResponseInterceptRequest
ResponseInterceptResponse
ResponseTransformRequest
SchedulerAuthCandidate
SchedulerOptions
SchedulerPickRaw
SchedulerPickRequest
SchedulerPickResponse
pluginapi.SchedulerPickResponse. Its custom UnmarshalJSON accepts the Go names and snake_case alternatives; a present Go name wins.
StaticModelRequest
StreamChunkInterceptRequest
StreamChunkInterceptResponse
ThinkingApplyRequest
ThinkingConfig
ThinkingSupport
UsageDetail
UsageFailure
UsageRecord
WebSocketResponseEvent

Constants§

AFFINITY_AMBIGUOUS
AFFINITY_BOUND
AFFINITY_UNBOUND
AFFINITY_UNSUPPORTED
AUTH_LOGIN_ERROR
AUTH_LOGIN_PENDING
AUTH_LOGIN_SUCCESS
COMPLETION_CANCELED
COMPLETION_FAILED
COMPLETION_REJECTED
COMPLETION_SUCCEEDED
ROUTE_TARGET_EXECUTOR
ROUTE_TARGET_PROVIDER
ROUTE_TARGET_SELF
SCHEDULER_BUILTIN_FILL_FIRST
SCHEDULER_BUILTIN_ROUND_ROBIN
STREAM_CHUNK_HEADER_INIT_INDEX
pluginapi.StreamChunkHeaderInitIndex.

Functions§

quota_fetch_from_value
Applies the snake_case fallbacks of the quota UnmarshalJSON methods to a decoded quota.fetch result. raw is the result object the plugin returned.