acp_sdk.models.models module¶

pydantic model acp_sdk.models.models.Agent[source]¶

Bases: BaseModel

field description: str | None = None¶

field metadata: Metadata = Metadata(annotations=None, documentation=None, license=None, programming_language=None, natural_languages=None, framework=None, capabilities=None, domains=None, tags=None, created_at=None, updated_at=None, author=None, contributors=None, links=None, dependencies=None, recommended_models=None)¶

field name: str [Required]¶

pydantic model acp_sdk.models.models.AnyModel[source]¶

Bases: BaseModel

Config:

extra: str = allow

pydantic model acp_sdk.models.models.Artifact[source]¶

Bases: MessagePart

Config:

extra: str = allow

field name: str [Required]¶

pydantic model acp_sdk.models.models.ArtifactEvent[source]¶

Bases: BaseModel

field part: Artifact [Required]¶

field type: Literal['message.part'] = 'message.part'¶

pydantic model acp_sdk.models.models.Author[source]¶

Bases: BaseModel

field email: str | None = None¶

field name: str [Required]¶

field url: AnyUrl | None = None¶

acp_sdk.models.models.AwaitRequest¶: alias of MessageAwaitRequest

acp_sdk.models.models.AwaitResume¶: alias of MessageAwaitResume

pydantic model acp_sdk.models.models.Capability[source]¶

Bases: BaseModel

field description: str [Required]¶

field name: str [Required]¶

pydantic model acp_sdk.models.models.Contributor[source]¶

Bases: BaseModel

field email: str | None = None¶

field name: str [Required]¶

field url: AnyUrl | None = None¶

pydantic model acp_sdk.models.models.Dependency[source]¶

Bases: BaseModel

field name: str [Required]¶

field type: DependencyType [Required]¶

class acp_sdk.models.models.DependencyType[source]¶

Bases: str, Enum

AGENT = 'agent'¶

MODEL = 'model'¶

TOOL = 'tool'¶

pydantic model acp_sdk.models.models.GenericEvent[source]¶

Bases: BaseModel

field generic: AnyModel [Required]¶

field type: Literal['generic'] = 'generic'¶

pydantic model acp_sdk.models.models.Link[source]¶

Bases: BaseModel

field type: LinkType [Required]¶

field url: AnyUrl [Required]¶

class acp_sdk.models.models.LinkType[source]¶

Bases: str, Enum

CONTAINER_IMAGE = 'container-image'¶

DOCUMENTATION = 'documentation'¶

HOMEPAGE = 'homepage'¶

SOURCE_CODE = 'source-code'¶

pydantic model acp_sdk.models.models.Message[source]¶

Bases: BaseModel

field completed_at: datetime | None [Optional]¶

field created_at: datetime | None [Optional]¶

field parts: list[MessagePart] [Required]¶

compress()[source]¶

Return type:: Message

pydantic model acp_sdk.models.models.MessageAwaitRequest[source]¶

Bases: BaseModel

field message: Message [Required]¶

field type: Literal['message'] = 'message'¶

pydantic model acp_sdk.models.models.MessageAwaitResume[source]¶

Bases: BaseModel

field message: Message [Required]¶

field type: Literal['message'] = 'message'¶

pydantic model acp_sdk.models.models.MessageCompletedEvent[source]¶

Bases: BaseModel

field message: Message [Required]¶

field type: Literal['message.completed'] = 'message.completed'¶

pydantic model acp_sdk.models.models.MessageCreatedEvent[source]¶

Bases: BaseModel

field message: Message [Required]¶

field type: Literal['message.created'] = 'message.created'¶

pydantic model acp_sdk.models.models.MessagePart[source]¶

Bases: BaseModel

Config:

extra: str = allow

field content: str | None = None¶

field content_encoding: Literal['plain', 'base64'] | None = 'plain'¶

field content_type: str | None = 'text/plain'¶

field content_url: AnyUrl | None = None¶

field name: str | None = None¶

model_post_init(_MessagePart__context)[source]¶

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Parameters:: _MessagePart__context (Any)
Return type:: None

pydantic model acp_sdk.models.models.MessagePartEvent[source]¶

Bases: BaseModel

field part: MessagePart [Required]¶

field type: Literal['message.part'] = 'message.part'¶

pydantic model acp_sdk.models.models.Metadata[source]¶

Bases: BaseModel

Config:

extra: str = allow

field annotations: AnyModel | None = None¶

field author: Author | None = None¶

field capabilities: list[Capability] | None = None¶

field contributors: list[Contributor] | None = None¶

field created_at: datetime | None = None¶

field dependencies: list[Dependency] | None = None¶

field documentation: str | None = None¶

field domains: list[str] | None = None¶

field framework: str | None = None¶

field license: str | None = None¶

field links: list[Link] | None = None¶

field natural_languages: list[str] | None = None¶

field programming_language: str | None = None¶

field recommended_models: list[str] | None = None¶

field tags: list[str] | None = None¶

field updated_at: datetime | None = None¶

pydantic model acp_sdk.models.models.Run[source]¶

Bases: BaseModel

field agent_name: str [Required]¶

field await_request: MessageAwaitRequest | None = None¶

field created_at: datetime [Optional]¶

field error: Error | None = None¶

field finished_at: datetime | None = None¶

field output: list[Message] = []¶

field run_id: UUID [Optional]¶

field session_id: UUID | None = None¶

field status: RunStatus = RunStatus.CREATED¶

raise_for_status()[source]¶

Return type:: Run

pydantic model acp_sdk.models.models.RunAwaitingEvent[source]¶

Bases: BaseModel

field run: Run [Required]¶

field type: Literal['run.awaiting'] = 'run.awaiting'¶

pydantic model acp_sdk.models.models.RunCancelledEvent[source]¶

Bases: BaseModel

field run: Run [Required]¶

field type: Literal['run.cancelled'] = 'run.cancelled'¶

pydantic model acp_sdk.models.models.RunCompletedEvent[source]¶

Bases: BaseModel

field run: Run [Required]¶

field type: Literal['run.completed'] = 'run.completed'¶

pydantic model acp_sdk.models.models.RunCreatedEvent[source]¶

Bases: BaseModel

field run: Run [Required]¶

field type: Literal['run.created'] = 'run.created'¶

pydantic model acp_sdk.models.models.RunFailedEvent[source]¶

Bases: BaseModel

field run: Run [Required]¶

field type: Literal['run.failed'] = 'run.failed'¶

pydantic model acp_sdk.models.models.RunInProgressEvent[source]¶

Bases: BaseModel

field run: Run [Required]¶

field type: Literal['run.in-progress'] = 'run.in-progress'¶

class acp_sdk.models.models.RunMode[source]¶

Bases: str, Enum

ASYNC = 'async'¶

STREAM = 'stream'¶

SYNC = 'sync'¶

class acp_sdk.models.models.RunStatus[source]¶

Bases: str, Enum

AWAITING = 'awaiting'¶

CANCELLED = 'cancelled'¶

CANCELLING = 'cancelling'¶

COMPLETED = 'completed'¶

CREATED = 'created'¶

FAILED = 'failed'¶

IN_PROGRESS = 'in-progress'¶

property is_terminal: bool¶