aaliagentgrpc

package
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 30, 2025 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	WorkflowRun_RunWorkflow_FullMethodName = "/aaliagentgrpc.WorkflowRun/RunWorkflow"
)

Variables

View Source
var File_pkg_aaliagentgrpc_aali_agent_proto protoreflect.FileDescriptor
View Source
var WorkflowRun_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aaliagentgrpc.WorkflowRun",
	HandlerType: (*WorkflowRunServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "RunWorkflow",
			Handler:       _WorkflowRun_RunWorkflow_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "pkg/aaliagentgrpc/aali-agent.proto",
}

WorkflowRun_ServiceDesc is the grpc.ServiceDesc for WorkflowRun service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterWorkflowRunServer

func RegisterWorkflowRunServer(s grpc.ServiceRegistrar, srv WorkflowRunServer)

Types

type AuthenticationStatus

type AuthenticationStatus struct {

	// Authentication status; can only be "failed"
	AuthenticationStatus string `protobuf:"bytes,1,opt,name=authenticationStatus,proto3" json:"authenticationStatus,omitempty"`
	// contains filtered or unexported fields
}

AuthenticationStatus is the message to indicate failing authentication after client sends a session context message with authentication enabled.

func (*AuthenticationStatus) Descriptor deprecated

func (*AuthenticationStatus) Descriptor() ([]byte, []int)

Deprecated: Use AuthenticationStatus.ProtoReflect.Descriptor instead.

func (*AuthenticationStatus) GetAuthenticationStatus

func (x *AuthenticationStatus) GetAuthenticationStatus() string

func (*AuthenticationStatus) ProtoMessage

func (*AuthenticationStatus) ProtoMessage()

func (*AuthenticationStatus) ProtoReflect

func (x *AuthenticationStatus) ProtoReflect() protoreflect.Message

func (*AuthenticationStatus) Reset

func (x *AuthenticationStatus) Reset()

func (*AuthenticationStatus) String

func (x *AuthenticationStatus) String() string

type ClientMessage

type ClientMessage struct {

	// Types that are valid to be assigned to MessageType:
	//
	//	*ClientMessage_SessionContext
	//	*ClientMessage_ClientRequest
	MessageType isClientMessage_MessageType `protobuf_oneof:"message_type"`
	// contains filtered or unexported fields
}

ClientMessage is the message sent by the client to the server.

func (*ClientMessage) Descriptor deprecated

func (*ClientMessage) Descriptor() ([]byte, []int)

Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.

func (*ClientMessage) GetClientRequest

func (x *ClientMessage) GetClientRequest() *ClientRequest

func (*ClientMessage) GetMessageType

func (x *ClientMessage) GetMessageType() isClientMessage_MessageType

func (*ClientMessage) GetSessionContext

func (x *ClientMessage) GetSessionContext() *SessionContext

func (*ClientMessage) ProtoMessage

func (*ClientMessage) ProtoMessage()

func (*ClientMessage) ProtoReflect

func (x *ClientMessage) ProtoReflect() protoreflect.Message

func (*ClientMessage) Reset

func (x *ClientMessage) Reset()

func (*ClientMessage) String

func (x *ClientMessage) String() string

type ClientMessage_ClientRequest

type ClientMessage_ClientRequest struct {
	// Client request message to send a request to the server
	ClientRequest *ClientRequest `protobuf:"bytes,2,opt,name=client_request,json=clientRequest,proto3,oneof"`
}

type ClientMessage_SessionContext

type ClientMessage_SessionContext struct {
	// Session context message to initiate a session
	SessionContext *SessionContext `protobuf:"bytes,1,opt,name=session_context,json=sessionContext,proto3,oneof"`
}

type ClientRequest

type ClientRequest struct {

	// Instruction ID which has to be equal to the instruction ID of the client response for chat interface interaction
	InstructionId string `protobuf:"bytes,1,opt,name=instruction_id,json=instructionId,proto3" json:"instruction_id,omitempty"`
	// Type of the request; can be "message", "get_variable_values", "set_variable_values", "keepalive", "take_snapshot", "load_snapshot", "get_slash_commands", "feedback"
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// String input for chat interface interaction
	Input string `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// Image input for chat interface interaction
	Images []string `protobuf:"bytes,4,rep,name=images,proto3" json:"images,omitempty"`
	// Variable values to be set for the workflow
	VariableValues map[string]string `` /* 177-byte string literal not displayed */
	// ID of the snapshot to be loaded
	SnapshotId string `protobuf:"bytes,6,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
	// Feedback for the workflow run
	Feedback *WorkflowFeedback `protobuf:"bytes,7,opt,name=feedback,proto3" json:"feedback,omitempty"` // Feedback for the workflow run
	// contains filtered or unexported fields
}

ClientRequest is the message to send a request to the server.

func (*ClientRequest) Descriptor deprecated

func (*ClientRequest) Descriptor() ([]byte, []int)

Deprecated: Use ClientRequest.ProtoReflect.Descriptor instead.

func (*ClientRequest) GetFeedback

func (x *ClientRequest) GetFeedback() *WorkflowFeedback

func (*ClientRequest) GetImages

func (x *ClientRequest) GetImages() []string

func (*ClientRequest) GetInput

func (x *ClientRequest) GetInput() string

func (*ClientRequest) GetInstructionId

func (x *ClientRequest) GetInstructionId() string

func (*ClientRequest) GetSnapshotId

func (x *ClientRequest) GetSnapshotId() string

func (*ClientRequest) GetType

func (x *ClientRequest) GetType() string

func (*ClientRequest) GetVariableValues

func (x *ClientRequest) GetVariableValues() map[string]string

func (*ClientRequest) ProtoMessage

func (*ClientRequest) ProtoMessage()

func (*ClientRequest) ProtoReflect

func (x *ClientRequest) ProtoReflect() protoreflect.Message

func (*ClientRequest) Reset

func (x *ClientRequest) Reset()

func (*ClientRequest) String

func (x *ClientRequest) String() string

type ClientResponse

type ClientResponse struct {

	// Randomly generated instruction ID to be used in the client request
	InstructionId string `protobuf:"bytes,1,opt,name=instruction_id,json=instructionId,proto3" json:"instruction_id,omitempty"`
	// Type of the response; can be "message", "stream", "info_message", "info_stream", "error", "info", "varaible_values", "snapshot_taken", "snapshot_loaded", "slash_commands", "feedback_received"
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Chat Interface properties
	IsLast           bool   `protobuf:"varint,3,opt,name=is_last,json=isLast,proto3" json:"is_last,omitempty"`
	Position         uint32 `protobuf:"varint,4,opt,name=position,proto3" json:"position,omitempty"`
	ChatData         string `protobuf:"bytes,5,opt,name=chat_data,json=chatData,proto3" json:"chat_data,omitempty"`
	CodeValidation   string `protobuf:"bytes,6,opt,name=code_validation,json=codeValidation,proto3" json:"code_validation,omitempty"` // "unvalidated", "valid", "warning", "invalid"
	InputTokenCount  int32  `protobuf:"varint,7,opt,name=input_token_count,json=inputTokenCount,proto3" json:"input_token_count,omitempty"`
	OutputTokenCount int32  `protobuf:"varint,8,opt,name=output_token_count,json=outputTokenCount,proto3" json:"output_token_count,omitempty"`
	Context          string `protobuf:"bytes,9,opt,name=context,proto3" json:"context,omitempty"`
	// Variable values properties
	VariableValues map[string]string `` /* 178-byte string literal not displayed */
	// Snapshot properties; id of the snapshot taken or loaded
	SnapshotId string `protobuf:"bytes,11,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
	// Slash command properties; list of slash commands supported by the workflow
	SlashCommands []string `protobuf:"bytes,12,rep,name=slash_commands,json=slashCommands,proto3" json:"slash_commands,omitempty"`
	// Error properties
	Error *ErrorResponse `protobuf:"bytes,13,opt,name=error,proto3" json:"error,omitempty"`
	// Info properties
	InfoMessage *string `protobuf:"bytes,14,opt,name=info_message,json=infoMessage,proto3,oneof" json:"info_message,omitempty"`
	// contains filtered or unexported fields
}

ClientResponse is the message to send a response to the client.

func (*ClientResponse) Descriptor deprecated

func (*ClientResponse) Descriptor() ([]byte, []int)

Deprecated: Use ClientResponse.ProtoReflect.Descriptor instead.

func (*ClientResponse) GetChatData

func (x *ClientResponse) GetChatData() string

func (*ClientResponse) GetCodeValidation

func (x *ClientResponse) GetCodeValidation() string

func (*ClientResponse) GetContext

func (x *ClientResponse) GetContext() string

func (*ClientResponse) GetError

func (x *ClientResponse) GetError() *ErrorResponse

func (*ClientResponse) GetInfoMessage

func (x *ClientResponse) GetInfoMessage() string

func (*ClientResponse) GetInputTokenCount

func (x *ClientResponse) GetInputTokenCount() int32

func (*ClientResponse) GetInstructionId

func (x *ClientResponse) GetInstructionId() string

func (*ClientResponse) GetIsLast

func (x *ClientResponse) GetIsLast() bool

func (*ClientResponse) GetOutputTokenCount

func (x *ClientResponse) GetOutputTokenCount() int32

func (*ClientResponse) GetPosition

func (x *ClientResponse) GetPosition() uint32

func (*ClientResponse) GetSlashCommands

func (x *ClientResponse) GetSlashCommands() []string

func (*ClientResponse) GetSnapshotId

func (x *ClientResponse) GetSnapshotId() string

func (*ClientResponse) GetType

func (x *ClientResponse) GetType() string

func (*ClientResponse) GetVariableValues

func (x *ClientResponse) GetVariableValues() map[string]string

func (*ClientResponse) ProtoMessage

func (*ClientResponse) ProtoMessage()

func (*ClientResponse) ProtoReflect

func (x *ClientResponse) ProtoReflect() protoreflect.Message

func (*ClientResponse) Reset

func (x *ClientResponse) Reset()

func (*ClientResponse) String

func (x *ClientResponse) String() string

type ConnectionStatus

type ConnectionStatus struct {

	// Connection status; can be "success", "failed"
	ConnectionStatus string `protobuf:"bytes,1,opt,name=connectionStatus,proto3" json:"connectionStatus,omitempty"`
	// Workflow Run ID; if the connection status is "success", this will be the ID of the workflow run
	WorkflowRunId string `protobuf:"bytes,2,opt,name=workflow_run_id,json=workflowRunId,proto3" json:"workflow_run_id,omitempty"`
	// Maximum number of snapshots that can be stored in the database per workflow run
	MaxNumberOfSnapshots int32 `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

ConnectionStatus is the message to indicate the connection status after client sends a session context message.

func (*ConnectionStatus) Descriptor deprecated

func (*ConnectionStatus) Descriptor() ([]byte, []int)

Deprecated: Use ConnectionStatus.ProtoReflect.Descriptor instead.

func (*ConnectionStatus) GetConnectionStatus

func (x *ConnectionStatus) GetConnectionStatus() string

func (*ConnectionStatus) GetMaxNumberOfSnapshots

func (x *ConnectionStatus) GetMaxNumberOfSnapshots() int32

func (*ConnectionStatus) GetWorkflowRunId

func (x *ConnectionStatus) GetWorkflowRunId() string

func (*ConnectionStatus) ProtoMessage

func (*ConnectionStatus) ProtoMessage()

func (*ConnectionStatus) ProtoReflect

func (x *ConnectionStatus) ProtoReflect() protoreflect.Message

func (*ConnectionStatus) Reset

func (x *ConnectionStatus) Reset()

func (*ConnectionStatus) String

func (x *ConnectionStatus) String() string

type ErrorResponse

type ErrorResponse struct {

	// Error code
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// Error message
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

ErrorResponse is the message to send an error response to the client.

func (*ErrorResponse) Descriptor deprecated

func (*ErrorResponse) Descriptor() ([]byte, []int)

Deprecated: Use ErrorResponse.ProtoReflect.Descriptor instead.

func (*ErrorResponse) GetCode

func (x *ErrorResponse) GetCode() int32

func (*ErrorResponse) GetMessage

func (x *ErrorResponse) GetMessage() string

func (*ErrorResponse) ProtoMessage

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) ProtoReflect

func (x *ErrorResponse) ProtoReflect() protoreflect.Message

func (*ErrorResponse) Reset

func (x *ErrorResponse) Reset()

func (*ErrorResponse) String

func (x *ErrorResponse) String() string

type ServerMessage

type ServerMessage struct {

	// Types that are valid to be assigned to MessageType:
	//
	//	*ServerMessage_ConnectionStatus
	//	*ServerMessage_AuthenticationStatus
	//	*ServerMessage_ClientResponse
	MessageType isServerMessage_MessageType `protobuf_oneof:"message_type"`
	// contains filtered or unexported fields
}

ServerMessage is the message sent by the server to the client.

func (*ServerMessage) Descriptor deprecated

func (*ServerMessage) Descriptor() ([]byte, []int)

Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.

func (*ServerMessage) GetAuthenticationStatus

func (x *ServerMessage) GetAuthenticationStatus() *AuthenticationStatus

func (*ServerMessage) GetClientResponse

func (x *ServerMessage) GetClientResponse() *ClientResponse

func (*ServerMessage) GetConnectionStatus

func (x *ServerMessage) GetConnectionStatus() *ConnectionStatus

func (*ServerMessage) GetMessageType

func (x *ServerMessage) GetMessageType() isServerMessage_MessageType

func (*ServerMessage) ProtoMessage

func (*ServerMessage) ProtoMessage()

func (*ServerMessage) ProtoReflect

func (x *ServerMessage) ProtoReflect() protoreflect.Message

func (*ServerMessage) Reset

func (x *ServerMessage) Reset()

func (*ServerMessage) String

func (x *ServerMessage) String() string

type ServerMessage_AuthenticationStatus

type ServerMessage_AuthenticationStatus struct {
	// Authentication status message to indicate failing authentication after client sends a session context message with authentication enabled
	AuthenticationStatus *AuthenticationStatus `protobuf:"bytes,2,opt,name=authentication_status,json=authenticationStatus,proto3,oneof"`
}

type ServerMessage_ClientResponse

type ServerMessage_ClientResponse struct {
	// Client response message to send a response to the client
	ClientResponse *ClientResponse `protobuf:"bytes,3,opt,name=client_response,json=clientResponse,proto3,oneof"`
}

type ServerMessage_ConnectionStatus

type ServerMessage_ConnectionStatus struct {
	// Connection status message to indicate the connection status after client sends a session context message
	ConnectionStatus *ConnectionStatus `protobuf:"bytes,1,opt,name=connection_status,json=connectionStatus,proto3,oneof"`
}

type SessionContext

type SessionContext struct {

	// JWT token for authentication
	JwtToken string `protobuf:"bytes,1,opt,name=jwt_token,json=jwtToken,proto3" json:"jwt_token,omitempty"`
	// Workflow ID for the workflow to be run
	WorkflowId string `protobuf:"bytes,2,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	// Variables to be passed to the workflow
	Variables map[string]string `` /* 145-byte string literal not displayed */
	// Snapshot ID; if defined, the given snapshot will retrived from the database
	SnapshotId string `protobuf:"bytes,4,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
	// Workflow run ID; mandatory if "snapshot_id" is defined in order to retrieve the snapshot from the database
	WorkflowRunId string `protobuf:"bytes,5,opt,name=workflow_run_id,json=workflowRunId,proto3" json:"workflow_run_id,omitempty"`
	// User ID; mandatory if "snapshot_id" is defined in order to retrieve the snapshot from the database
	UserId string `protobuf:"bytes,6,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Store snapshots; if true, all taken snapshots will be stored in the database
	StoreSnapshots bool `protobuf:"varint,7,opt,name=store_snapshots,json=storeSnapshots,proto3" json:"store_snapshots,omitempty"`
	// contains filtered or unexported fields
}

SessionContext is the message to initiate a session with the server.

func (*SessionContext) Descriptor deprecated

func (*SessionContext) Descriptor() ([]byte, []int)

Deprecated: Use SessionContext.ProtoReflect.Descriptor instead.

func (*SessionContext) GetJwtToken

func (x *SessionContext) GetJwtToken() string

func (*SessionContext) GetSnapshotId

func (x *SessionContext) GetSnapshotId() string

func (*SessionContext) GetStoreSnapshots

func (x *SessionContext) GetStoreSnapshots() bool

func (*SessionContext) GetUserId

func (x *SessionContext) GetUserId() string

func (*SessionContext) GetVariables

func (x *SessionContext) GetVariables() map[string]string

func (*SessionContext) GetWorkflowId

func (x *SessionContext) GetWorkflowId() string

func (*SessionContext) GetWorkflowRunId

func (x *SessionContext) GetWorkflowRunId() string

func (*SessionContext) ProtoMessage

func (*SessionContext) ProtoMessage()

func (*SessionContext) ProtoReflect

func (x *SessionContext) ProtoReflect() protoreflect.Message

func (*SessionContext) Reset

func (x *SessionContext) Reset()

func (*SessionContext) String

func (x *SessionContext) String() string

type UnimplementedWorkflowRunServer

type UnimplementedWorkflowRunServer struct{}

UnimplementedWorkflowRunServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedWorkflowRunServer) RunWorkflow

type UnsafeWorkflowRunServer

type UnsafeWorkflowRunServer interface {
	// contains filtered or unexported methods
}

UnsafeWorkflowRunServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WorkflowRunServer will result in compilation errors.

type WorkflowFeedback

type WorkflowFeedback struct {

	// Message ID which has to be equal to the message ID in the conversation history for which the feedback is given
	MessageId string `protobuf:"bytes,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// Positive or negative feedback can either be added or removed to the message ID in the conversation history
	AddPositive    bool `protobuf:"varint,2,opt,name=add_positive,json=addPositive,proto3" json:"add_positive,omitempty"`
	AddNegative    bool `protobuf:"varint,3,opt,name=add_negative,json=addNegative,proto3" json:"add_negative,omitempty"`
	RemovePositive bool `protobuf:"varint,4,opt,name=remove_positive,json=removePositive,proto3" json:"remove_positive,omitempty"`
	RemoveNegative bool `protobuf:"varint,5,opt,name=remove_negative,json=removeNegative,proto3" json:"remove_negative,omitempty"`
	// contains filtered or unexported fields
}

WorkflowFeedback is the message to send feedback to the server.

func (*WorkflowFeedback) Descriptor deprecated

func (*WorkflowFeedback) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowFeedback.ProtoReflect.Descriptor instead.

func (*WorkflowFeedback) GetAddNegative

func (x *WorkflowFeedback) GetAddNegative() bool

func (*WorkflowFeedback) GetAddPositive

func (x *WorkflowFeedback) GetAddPositive() bool

func (*WorkflowFeedback) GetMessageId

func (x *WorkflowFeedback) GetMessageId() string

func (*WorkflowFeedback) GetRemoveNegative

func (x *WorkflowFeedback) GetRemoveNegative() bool

func (*WorkflowFeedback) GetRemovePositive

func (x *WorkflowFeedback) GetRemovePositive() bool

func (*WorkflowFeedback) ProtoMessage

func (*WorkflowFeedback) ProtoMessage()

func (*WorkflowFeedback) ProtoReflect

func (x *WorkflowFeedback) ProtoReflect() protoreflect.Message

func (*WorkflowFeedback) Reset

func (x *WorkflowFeedback) Reset()

func (*WorkflowFeedback) String

func (x *WorkflowFeedback) String() string

type WorkflowRunClient

type WorkflowRunClient interface {
	// Bidirectional streaming RPC
	RunWorkflow(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[ClientMessage, ServerMessage], error)
}

WorkflowRunClient is the client API for WorkflowRun service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

WorkflowRun is a gRPC service that allows for running a workflow.

type WorkflowRunServer

type WorkflowRunServer interface {
	// Bidirectional streaming RPC
	RunWorkflow(grpc.BidiStreamingServer[ClientMessage, ServerMessage]) error
	// contains filtered or unexported methods
}

WorkflowRunServer is the server API for WorkflowRun service. All implementations must embed UnimplementedWorkflowRunServer for forward compatibility.

WorkflowRun is a gRPC service that allows for running a workflow.

type WorkflowRun_RunWorkflowClient

type WorkflowRun_RunWorkflowClient = grpc.BidiStreamingClient[ClientMessage, ServerMessage]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type WorkflowRun_RunWorkflowServer

type WorkflowRun_RunWorkflowServer = grpc.BidiStreamingServer[ClientMessage, ServerMessage]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL