API Reference

Visit the Agent Spec API Documentation to learn more about the native Agent Spec Components.

Agent Spec - API Reference

Tip

Click the button above ↑ to visit the Agent Spec Documentation

• Agent Spec Adapters
  • AgentSpecExporter
    • AgentSpecExporter.to_component()
    • AgentSpecExporter.to_json()
    • AgentSpecExporter.to_yaml()
  • AgentSpecLoader
    • AgentSpecLoader.load_component()
    • AgentSpecLoader.load_json()
    • AgentSpecLoader.load_yaml()
• Custom Components
  • Extended Components
    • ExtendedAgent
    • ExtendedFlow
    • ExtendedToolNode
    • ExtendedLlmNode
    • ExtendedMapNode
  • Plugin Components
    • Model Context Protocol (MCP)
    • Agentic patterns
    • Messages
    • Nodes
    • Context Providers
    • Datastores
• Conversations
  • Conversation & Messages
    • Conversation
    • Message
    • MessageType
    • MessageList
  • ExecutionStatus
    • ExecutionStatus
    • UserMessageRequestStatus
    • FinishedStatus
    • ToolRequestStatus
  • Conversation
    • ConversationalComponent
• LLMs
  • LlmModel
    • LlmModel
  • LlmModelFactory
    • LlmModelFactory
  • Token Usage
    • TokenUsage
  • LLM Generation Config
    • LlmGenerationConfig
  • All models
    • OpenAI Compatible Models
    • OpenAI Models
    • Ollama Models
    • VLLM Models
    • OCI GenAI Models
• Events
  • Events
    • Event
    • LlmGenerationRequestEvent
    • LlmGenerationResponseEvent
    • ConversationalComponentExecutionStartedEvent
    • ConversationalComponentExecutionFinishedEvent
    • ConversationCreatedEvent
    • ConversationMessageAddedEvent
  • Event Listeners
    • EventListener
    • GenericEventListener
    • register_event_listeners()
    • get_event_listeners()
    • record_event()
• Flows
  • Flows & Steps
    • Flow
    • Step
    • DataFlowEdge
    • ControlFlowEdge
  • Task steps
    • AgentExecutionStep
    • PromptExecutionStep
    • TemplateRenderingStep
    • ToolExecutionStep
    • ExtractValueFromJsonStep
    • RegexExtractionStep
    • Datastore tasks
  • IO steps
    • InputMessageStep
    • OutputMessageStep
    • GetChatHistoryStep
    • VariableReadStep
    • VariableWriteStep
    • ConstantValuesStep
  • Flow steps
    • RetryStep
    • CatchExceptionStep
    • FlowExecutionStep
    • MapStep
    • BranchingStep
    • ChoiceSelectionStep
    • CompleteStep
    • StartStep
    • ApiCallStep
  • Classes for the IO system properties
    • Property
    • BooleanProperty
    • FloatProperty
    • MessageProperty
    • IntegerProperty
    • StringProperty
    • AnyProperty
    • ListProperty
    • DictProperty
    • ObjectProperty
    • UnionProperty
    • NullProperty
  • Other classes and helpers used in fixed flows
    • StepResult
    • run_step_and_return_outputs
    • run_flow_and_return_outputs
    • create_single_step_flow
• Agents
  • Agent related classes
    • Agent class
    • OCI Agent class
    • DescribedFlow
    • DescribedAgent
    • Swarm class
    • ManagerWorkers class
• Embedding Models
  • EmbeddingModel
    • EmbeddingModel
  • All models
    • OpenAI Compatible Embedding Models
    • OpenAI Embedding Models
    • VLLM Embedding Models
    • OCI GenAI Embedding Models
    • Ollama Embedding Models
• Context Providers
  • Base classes
    • ContextProvider
  • Available Context Providers
    • ToolContextProvider
    • FlowContextProvider
    • ChatHistoryContextProvider
• Execution Interrupts
  • Execution Interrupt interface
    • ExecutionInterrupt
    • InterruptedExecutionStatus
  • Basic Execution Interrupt classes
    • Timeout Execution Interrupt
    • Token Limit Execution Interrupt
• PromptTemplates
  • PromptTemplate
    • PromptTemplate.CHAT_HISTORY_PLACEHOLDER
    • PromptTemplate.CHAT_HISTORY_PLACEHOLDER_NAME
    • PromptTemplate.RESPONSE_FORMAT_PLACEHOLDER_NAME
    • PromptTemplate.TOOL_PLACEHOLDER_NAME
    • PromptTemplate.copy()
    • PromptTemplate.format()
    • PromptTemplate.from_string()
    • PromptTemplate.generation_config
    • PromptTemplate.input_descriptors
    • PromptTemplate.messages
    • PromptTemplate.native_structured_generation
    • PromptTemplate.native_tool_calling
    • PromptTemplate.output_parser
    • PromptTemplate.post_rendering_transforms
    • PromptTemplate.pre_rendering_transforms
    • PromptTemplate.response_format
    • PromptTemplate.tools
    • PromptTemplate.with_additional_post_rendering_transform()
    • PromptTemplate.with_generation_config()
    • PromptTemplate.with_output_parser()
    • PromptTemplate.with_partial()
    • PromptTemplate.with_response_format()
    • PromptTemplate.with_tools()
  • OutputParser
    • OutputParser
    • RegexOutputParser
    • RegexPattern
    • JsonOutputParser
    • ToolOutputParser
  • Message transforms
    • MessageTransform
    • CoalesceSystemMessagesTransform
    • RemoveEmptyNonUserMessageTransform
    • AppendTrailingSystemMessageToUserMessageTransform
  • Helpers
    • adapt_prompt_template_for_json_structured_generation()
• Serialization/Deserialization
  • Base classes
    • SerializableObject
  • Serialization
    • serialize()
  • Deserialization
    • deserialize()
    • autodeserialize()
• Tools
  • Client Tool
    • ClientTool
  • Server Tool
    • ServerTool
  • Remote Tool
    • RemoteTool
  • MCP Tool
    • MCPTool
    • MCPToolBox
    • SessionParameters
    • enable_mcp_without_auth()
    • ClientTransport
    • StdioTransport
    • SSETransport
    • SSEmTLSTransport
    • StreamableHTTPTransport
    • StreamableHTTPmTLSTransport
  • Tool decorator
    • tool()
  • Tool-related Classes
    • ToolRequest
    • ToolResult
• Tracing
  • Trace
    • get_trace()
    • Trace
  • Spans
    • get_current_span()
    • get_active_span_stack()
    • Span
    • LlmGenerationSpan
    • ConversationalComponentExecutionSpan
    • ConversationSpan
    • ToolExecutionSpan
    • StepInvocationSpan
    • ContextProviderExecutionSpan
  • Span Processors
    • SpanProcessor
    • SimpleSpanProcessor
  • Span Exporter
    • SpanExporter
  • OpenTelemetry
    • OtelSimpleSpanProcessor
    • OtelBatchSpanProcessor
• Variables
  • Variable
    • Variable.default_value
    • Variable.from_dict()
    • Variable.from_property()
    • Variable.to_dict()
    • Variable.to_property()
    • Variable.type
  • VariableWriteOperation
    • VariableWriteOperation.INSERT
    • VariableWriteOperation.MERGE
    • VariableWriteOperation.OVERWRITE
• Datastores
  • Entity
    • Entity
    • nullable
  • Base class
    • Datastore
  • In memory
    • InMemoryDatastore
  • Oracle Database
    • OracleDatabaseConnectionConfig
    • TlsOracleDatabaseConnectionConfig
    • MTlsOracleDatabaseConnectionConfig
    • OracleDatabaseDatastore
• Warnings
  • SecurityWarning
• Evaluation
  • Assistant Evaluation
    • EvaluationTask
    • EvaluationEnvironment
    • AssistantEvaluator
    • TaskScorer
    • run_proxy_agent_conversation
  • Conversation Evaluation
    • ConversationEvaluator
    • ConversationScorer
    • UsefulnessScorer
    • UserHappinessScorer
    • CriteriaScorer
    • DEFAULT_SCORE_MAP
  • Evaluation Metrics
    • calculate_set_metrics()
    • calculate_accuracy()