http4k-ai-a2a-core/org.http4k.ai.a2a.model

Package-level declarations

Types

@JsonSerializable

data class AgentCapabilities(val streaming: Boolean? = true, val pushNotifications: Boolean? = true, val extendedAgentCard: Boolean? = true, val extensions: List<AgentExtension>? = null)

AgentCard

@JsonSerializable

data class AgentCard(val name: String, val version: Version, val description: String, val capabilities: AgentCapabilities = AgentCapabilities(), val skills: List<AgentSkill> = emptyList(), val defaultInputModes: List<MimeType> = emptyList(), val defaultOutputModes: List<MimeType> = emptyList(), val provider: AgentProvider? = null, val documentationUrl: Uri? = null, val iconUrl: Uri? = null, val supportedInterfaces: List<AgentInterface> = emptyList(), val securitySchemes: Map<String, SecurityScheme>? = null, val securityRequirements: List<SecurityRequirement>? = null, val signatures: List<AgentCardSignature>? = null)

AgentCardProvider

interface AgentCardProvider

AgentCardSignature

@JsonSerializable

data class AgentCardSignature(@Json(name = "protected") val protectedHeader: String, val signature: String, val header: Map<String, Any>? = null)

AgentExtension

@JsonSerializable

data class AgentExtension(val uri: Uri, val description: String? = null, val required: Boolean = false, val params: Map<String, Any>? = null)

AgentInterface

@JsonSerializable

data class AgentInterface(val url: Uri, val protocolBinding: String, val protocolVersion: ProtocolVersion, val tenant: Tenant? = null)

AgentProvider

@JsonSerializable

data class AgentProvider(val organization: String, val url: Uri)

AgentSkill

@JsonSerializable

data class AgentSkill(val id: SkillId, val name: String, val description: String, val tags: List<String> = emptyList(), val examples: List<String>? = null, val inputModes: List<MimeType>? = null, val outputModes: List<MimeType>? = null, val securityRequirements: List<SecurityRequirement>? = null)

Artifact

@JsonSerializable

data class Artifact(val artifactId: ArtifactId, val parts: List<Part>, val name: String? = null, val description: String? = null, val metadata: Map<String, Any>? = null, val extensions: List<String>? = null)

ArtifactId

class ArtifactId : AbstractValue<String>

AuthenticationInfo

@JsonSerializable

data class AuthenticationInfo(val scheme: AuthScheme, val credentials: String? = null)

AuthScheme

class AuthScheme : AbstractValue<String>

ContextId

class ContextId : AbstractValue<String>

CreateTaskPushNotificationConfig

@JsonSerializable

data class CreateTaskPushNotificationConfig(val taskId: TaskId, val url: Uri, val token: String? = null, val authentication: AuthenticationInfo? = null)

Message

@JsonSerializable

data class Message(val messageId: MessageId, val role: A2ARole, val parts: List<Part>, val contextId: ContextId? = null, val taskId: TaskId? = null, val metadata: Map<String, Any>? = null, val extensions: List<String>? = null, val referenceTaskIds: List<TaskId>? = null) : StreamItem, MessageResponse

MessageId

class MessageId : AbstractValue<String>

MessageRequest

data class MessageRequest(val message: Message, val configuration: SendMessageConfiguration? = null, val metadata: Map<String, Any>? = null, val http: Request)

MessageResponse

sealed interface MessageResponse

OAuthFlows

sealed class OAuthFlows

OAuthFlowsJsonAdapterFactory

object OAuthFlowsJsonAdapterFactory : JsonAdapter.Factory

PageToken

class PageToken : AbstractValue<String>

Part

sealed class Part

PartJsonAdapterFactory

object PartJsonAdapterFactory : JsonAdapter.Factory

PushNotificationConfigId

class PushNotificationConfigId : AbstractValue<String>

PushNotificationConfigPage

@JsonSerializable

data class PushNotificationConfigPage(val configs: List<TaskPushNotificationConfig>, val nextPageToken: PageToken? = null)

ResponseStream

data class ResponseStream(items: Sequence<StreamItem>) : MessageResponse, Sequence<StreamItem>

SecurityRequirement

@JsonSerializable

data class SecurityRequirement(val schemes: Map<String, List<String>>)

SecurityScheme

sealed class SecurityScheme

SecuritySchemeJsonAdapterFactory

object SecuritySchemeJsonAdapterFactory : JsonAdapter.Factory

SkillId

class SkillId : AbstractValue<String>

StreamItem

sealed interface StreamItem

StreamItemJsonAdapterFactory

object StreamItemJsonAdapterFactory : JsonAdapter.Factory

Task

@JsonSerializable

data class Task(val id: TaskId, val status: TaskStatus, val contextId: ContextId? = null, val artifacts: List<Artifact>? = null, val history: List<Message>? = null, val metadata: Map<String, Any>? = null) : StreamItem, MessageResponse

TaskArtifactUpdateEvent

@JsonSerializable

data class TaskArtifactUpdateEvent(val taskId: TaskId, val contextId: ContextId, val artifact: Artifact, val append: Boolean? = null, val lastChunk: Boolean? = null, val metadata: Map<String, Any>? = null) : StreamItem

TaskId

class TaskId : AbstractValue<String>

TaskPage

@JsonSerializable

data class TaskPage(val tasks: List<Task>, val nextPageToken: PageToken = PageToken.END, val pageSize: Int = 0, val totalSize: Int)

TaskPushNotificationConfig

@JsonSerializable

data class TaskPushNotificationConfig(val id: PushNotificationConfigId, val taskId: TaskId, val url: Uri, val token: String? = null, val authentication: AuthenticationInfo? = null, val tenant: Tenant? = null)

TaskState

enum TaskState : Enum<TaskState>

TaskStatus

@JsonSerializable

data class TaskStatus(val state: TaskState, val message: Message? = null, val timestamp: Instant? = null)

TaskStatusUpdateEvent

@JsonSerializable

data class TaskStatusUpdateEvent(val taskId: TaskId, val contextId: ContextId, val status: TaskStatus, val metadata: Map<String, Any>? = null) : StreamItem

Tenant

class Tenant : AbstractValue<String>

Version

class Version : AbstractValue<String>