API Reference

This page contains auto-generated API reference documentation [1].

• aiq
  • aiq.agent
    • aiq.agent.base
    • aiq.agent.react_agent
      • aiq.agent.react_agent.agent
      • aiq.agent.react_agent.output_parser
      • aiq.agent.react_agent.prompt
      • aiq.agent.react_agent.register
    • aiq.agent.reasoning_agent
      • aiq.agent.reasoning_agent.reasoning_agent
    • aiq.agent.register
    • aiq.agent.tool_calling_agent
      • aiq.agent.tool_calling_agent.agent
      • aiq.agent.tool_calling_agent.register
  • aiq.builder
    • aiq.builder.builder
    • aiq.builder.component_utils
    • aiq.builder.context
    • aiq.builder.embedder
    • aiq.builder.eval_builder
    • aiq.builder.evaluator
    • aiq.builder.framework_enum
    • aiq.builder.front_end
    • aiq.builder.function
    • aiq.builder.function_base
    • aiq.builder.function_info
    • aiq.builder.intermediate_step_manager
    • aiq.builder.llm
    • aiq.builder.retriever
    • aiq.builder.user_interaction_manager
    • aiq.builder.workflow
    • aiq.builder.workflow_builder
  • aiq.cli
    • aiq.cli.cli_utils
      • aiq.cli.cli_utils.config_override
      • aiq.cli.cli_utils.validation
    • aiq.cli.commands
      • aiq.cli.commands.configure
        • aiq.cli.commands.configure.channel
          • aiq.cli.commands.configure.channel.add
          • aiq.cli.commands.configure.channel.channel
          • aiq.cli.commands.configure.channel.remove
          • aiq.cli.commands.configure.channel.update
        • aiq.cli.commands.configure.configure
      • aiq.cli.commands.evaluate
      • aiq.cli.commands.info
        • aiq.cli.commands.info.info
        • aiq.cli.commands.info.list_channels
        • aiq.cli.commands.info.list_components
      • aiq.cli.commands.registry
        • aiq.cli.commands.registry.publish
        • aiq.cli.commands.registry.pull
        • aiq.cli.commands.registry.registry
        • aiq.cli.commands.registry.remove
        • aiq.cli.commands.registry.search
      • aiq.cli.commands.start
      • aiq.cli.commands.uninstall
      • aiq.cli.commands.validate
      • aiq.cli.commands.workflow
        • aiq.cli.commands.workflow.workflow
        • aiq.cli.commands.workflow.workflow_commands
    • aiq.cli.entrypoint
    • aiq.cli.main
    • aiq.cli.register_workflow
    • aiq.cli.type_registry
  • aiq.data_models
    • aiq.data_models.api_server
    • aiq.data_models.common
    • aiq.data_models.component
    • aiq.data_models.component_ref
    • aiq.data_models.config
    • aiq.data_models.dataset_handler
    • aiq.data_models.discovery_metadata
    • aiq.data_models.embedder
    • aiq.data_models.evaluate
    • aiq.data_models.evaluator
    • aiq.data_models.front_end
    • aiq.data_models.function
    • aiq.data_models.function_dependencies
    • aiq.data_models.interactive
    • aiq.data_models.intermediate_step
    • aiq.data_models.invocation_node
    • aiq.data_models.llm
    • aiq.data_models.logging
    • aiq.data_models.memory
    • aiq.data_models.profiler
    • aiq.data_models.registry_handler
    • aiq.data_models.retriever
    • aiq.data_models.step_adaptor
    • aiq.data_models.streaming
    • aiq.data_models.swe_bench_model
    • aiq.data_models.telemetry_exporter
  • aiq.embedder
    • aiq.embedder.langchain_client
    • aiq.embedder.nim_embedder
    • aiq.embedder.register
  • aiq.eval
    • aiq.eval.config
    • aiq.eval.dataset_handler
      • aiq.eval.dataset_handler.dataset_downloader
      • aiq.eval.dataset_handler.dataset_filter
      • aiq.eval.dataset_handler.dataset_handler
    • aiq.eval.evaluate
    • aiq.eval.evaluator
      • aiq.eval.evaluator.evaluator_model
    • aiq.eval.intermediate_step_adapter
    • aiq.eval.rag_evaluator
      • aiq.eval.rag_evaluator.evaluate
      • aiq.eval.rag_evaluator.register
    • aiq.eval.register
    • aiq.eval.remote_workflow
    • aiq.eval.runtime_event_subscriber
    • aiq.eval.swe_bench_evaluator
      • aiq.eval.swe_bench_evaluator.evaluate
      • aiq.eval.swe_bench_evaluator.register
    • aiq.eval.trajectory_evaluator
      • aiq.eval.trajectory_evaluator.evaluate
      • aiq.eval.trajectory_evaluator.register
  • aiq.front_ends
    • aiq.front_ends.console
      • aiq.front_ends.console.console_front_end_config
      • aiq.front_ends.console.console_front_end_plugin
      • aiq.front_ends.console.register
    • aiq.front_ends.cron
    • aiq.front_ends.fastapi
      • aiq.front_ends.fastapi.fastapi_front_end_config
      • aiq.front_ends.fastapi.fastapi_front_end_plugin
      • aiq.front_ends.fastapi.fastapi_front_end_plugin_worker
      • aiq.front_ends.fastapi.intermediate_steps_subscriber
      • aiq.front_ends.fastapi.main
      • aiq.front_ends.fastapi.message_handler
      • aiq.front_ends.fastapi.message_validator
      • aiq.front_ends.fastapi.register
      • aiq.front_ends.fastapi.response_helpers
      • aiq.front_ends.fastapi.step_adaptor
      • aiq.front_ends.fastapi.websocket
    • aiq.front_ends.register
    • aiq.front_ends.simple_base
      • aiq.front_ends.simple_base.simple_front_end_plugin_base
  • aiq.llm
    • aiq.llm.nim_llm
    • aiq.llm.openai_llm
    • aiq.llm.register
    • aiq.llm.utils
      • aiq.llm.utils.env_config_value
      • aiq.llm.utils.error
  • aiq.memory
    • aiq.memory.interfaces
    • aiq.memory.models
  • aiq.observability
    • aiq.observability.async_otel_listener
    • aiq.observability.register
  • aiq.profiler
    • aiq.profiler.callbacks
      • aiq.profiler.callbacks.base_callback_class
      • aiq.profiler.callbacks.langchain_callback_handler
      • aiq.profiler.callbacks.llama_index_callback_handler
      • aiq.profiler.callbacks.semantic_kernel_callback_handler
      • aiq.profiler.callbacks.token_usage_base_model
    • aiq.profiler.data_frame_row
    • aiq.profiler.decorators
    • aiq.profiler.forecasting
      • aiq.profiler.forecasting.config
      • aiq.profiler.forecasting.model_trainer
      • aiq.profiler.forecasting.models
        • aiq.profiler.forecasting.models.forecasting_base_model
        • aiq.profiler.forecasting.models.linear_model
        • aiq.profiler.forecasting.models.random_forest_regressor
    • aiq.profiler.inference_metrics_model
    • aiq.profiler.inference_optimization
      • aiq.profiler.inference_optimization.bottleneck_analysis
        • aiq.profiler.inference_optimization.bottleneck_analysis.nested_stack_analysis
        • aiq.profiler.inference_optimization.bottleneck_analysis.simple_stack_analysis
      • aiq.profiler.inference_optimization.data_models
      • aiq.profiler.inference_optimization.experimental
        • aiq.profiler.inference_optimization.experimental.concurrency_spike_analysis
        • aiq.profiler.inference_optimization.experimental.prefix_span_analysis
      • aiq.profiler.inference_optimization.llm_metrics
      • aiq.profiler.inference_optimization.prompt_caching
      • aiq.profiler.inference_optimization.token_uniqueness
      • aiq.profiler.inference_optimization.workflow_runtimes
    • aiq.profiler.intermediate_property_adapter
    • aiq.profiler.profile_runner
    • aiq.profiler.utils
  • aiq.registry_handlers
    • aiq.registry_handlers.local
      • aiq.registry_handlers.local.local_handler
      • aiq.registry_handlers.local.register_local
    • aiq.registry_handlers.metadata_factory
    • aiq.registry_handlers.package_utils
    • aiq.registry_handlers.pypi
      • aiq.registry_handlers.pypi.pypi_handler
      • aiq.registry_handlers.pypi.register_pypi
    • aiq.registry_handlers.register
    • aiq.registry_handlers.registry_handler_base
    • aiq.registry_handlers.rest
      • aiq.registry_handlers.rest.register_rest
      • aiq.registry_handlers.rest.rest_handler
    • aiq.registry_handlers.schemas
      • aiq.registry_handlers.schemas.headers
      • aiq.registry_handlers.schemas.package
      • aiq.registry_handlers.schemas.publish
      • aiq.registry_handlers.schemas.pull
      • aiq.registry_handlers.schemas.remove
      • aiq.registry_handlers.schemas.search
      • aiq.registry_handlers.schemas.status
  • aiq.retriever
    • aiq.retriever.interface
    • aiq.retriever.milvus
      • aiq.retriever.milvus.register
      • aiq.retriever.milvus.retriever
    • aiq.retriever.models
    • aiq.retriever.nemo_retriever
      • aiq.retriever.nemo_retriever.register
      • aiq.retriever.nemo_retriever.retriever
    • aiq.retriever.register
  • aiq.runtime
    • aiq.runtime.loader
    • aiq.runtime.runner
    • aiq.runtime.session
  • aiq.settings
    • aiq.settings.global_settings
  • aiq.tool
    • aiq.tool.code_execution
      • aiq.tool.code_execution.code_sandbox
      • aiq.tool.code_execution.local_sandbox
        • aiq.tool.code_execution.local_sandbox.local_sandbox_server
      • aiq.tool.code_execution.register
      • aiq.tool.code_execution.utils
    • aiq.tool.datetime_tools
    • aiq.tool.document_search
    • aiq.tool.github_tools
      • aiq.tool.github_tools.create_github_commit
      • aiq.tool.github_tools.create_github_issue
      • aiq.tool.github_tools.create_github_pr
      • aiq.tool.github_tools.get_github_file
      • aiq.tool.github_tools.get_github_issue
      • aiq.tool.github_tools.get_github_pr
      • aiq.tool.github_tools.update_github_issue
    • aiq.tool.mcp
      • aiq.tool.mcp.mcp_client
      • aiq.tool.mcp.mcp_tool
    • aiq.tool.memory_tools
      • aiq.tool.memory_tools.add_memory_tool
      • aiq.tool.memory_tools.delete_memory_tool
      • aiq.tool.memory_tools.get_memory_tool
    • aiq.tool.nvidia_rag
    • aiq.tool.register
    • aiq.tool.retriever
  • aiq.utils
    • aiq.utils.data_models
      • aiq.utils.data_models.schema_validator
    • aiq.utils.debugging_utils
    • aiq.utils.exception_handlers
      • aiq.utils.exception_handlers.schemas
    • aiq.utils.io
      • aiq.utils.io.yaml_tools
    • aiq.utils.metadata_utils
    • aiq.utils.producer_consumer_queue
    • aiq.utils.reactive
      • aiq.utils.reactive.base
        • aiq.utils.reactive.base.observable_base
        • aiq.utils.reactive.base.observer_base
        • aiq.utils.reactive.base.subject_base
      • aiq.utils.reactive.observable
      • aiq.utils.reactive.observer
      • aiq.utils.reactive.subject
      • aiq.utils.reactive.subscription
    • aiq.utils.settings
      • aiq.utils.settings.global_settings
    • aiq.utils.type_converter
    • aiq.utils.type_utils
    • aiq.utils.url_utils

[1]

Created with sphinx-autoapi