Migration Guide

NeMo Agent toolkit is designed to be backwards compatible with the previous version of the toolkit except for changes documented on this page.

Additionally, all new contributions should rely on the most recent version of the toolkit and not rely on any deprecated functionality.

Migrating to a new version of NeMo Agent toolkit

It is strongly encouraged to migrate any existing code to the latest conventions and remove any deprecated functionality.

Version Specific Changes

v1.2.0

Package Changes

• The aiqtoolkit package has been renamed to nvidia-nat.

Warning

aiqtoolkit will be removed in a future release and is published as a transitional package.

Module Changes

• The aiq module has been deprecated. Use nat instead.

Warning

aiq will be removed in a future release.

CLI Changes

• The aiq command has been deprecated. Use nat instead.

Warning

The aiq command will be removed in a future release.

API Changes

Note

Compatibility aliases are in place to ensure backwards compatibility, however it is strongly encouraged to migrate to the new names.

• Types which previously contained AIQ have had their AIQ prefix removed.

  • aiq.data_models.config.AIQConfig -> nat.data_models.config.Config

  • aiq.builder.context.AIQContext -> nat.builder.context.Context

  • aiq.builder.context.AIQContextState -> nat.builder.context.ContextState

  • aiq.builder.user_interaction_manager.AIQUserInteractionManager -> nat.builder.user_interaction_manager.UserInteractionManager

  • aiq.cli.commands.workflow.workflow_commands.AIQPackageError -> nat.cli.commands.workflow.workflow_commands.PackageError

  • aiq.data_models.api_server.AIQChatRequest -> nat.data_models.api_server.ChatRequest

  • aiq.data_models.api_server.AIQChoiceMessage -> nat.data_models.api_server.ChoiceMessage

  • aiq.data_models.api_server.AIQChoiceDelta -> nat.data_models.api_server.ChoiceDelta

  • aiq.data_models.api_server.AIQChoice -> nat.data_models.api_server.Choice

  • aiq.data_models.api_server.AIQUsage -> nat.data_models.api_server.Usage

  • aiq.data_models.api_server.AIQResponseSerializable -> nat.data_models.api_server.ResponseSerializable

  • aiq.data_models.api_server.AIQResponseBaseModelOutput -> nat.data_models.api_server.ResponseBaseModelOutput

  • aiq.data_models.api_server.AIQResponseBaseModelIntermediate -> nat.data_models.api_server.ResponseBaseModelIntermediate

  • aiq.data_models.api_server.AIQChatResponse -> nat.data_models.api_server.ChatResponse

  • aiq.data_models.api_server.AIQChatResponseChunk -> nat.data_models.api_server.ChatResponseChunk

  • aiq.data_models.api_server.AIQResponseIntermediateStep -> nat.data_models.api_server.ResponseIntermediateStep

  • aiq.data_models.api_server.AIQResponsePayloadOutput -> nat.data_models.api_server.ResponsePayloadOutput

  • aiq.data_models.api_server.AIQGenerateResponse -> nat.data_models.api_server.GenerateResponse

  • aiq.data_models.component.AIQComponentEnum -> nat.data_models.component.ComponentEnum

  • aiq.front_ends.fastapi.fastapi_front_end_config.AIQEvaluateRequest -> nat.front_ends.fastapi.fastapi_front_end_config.EvaluateRequest

  • aiq.front_ends.fastapi.fastapi_front_end_config.AIQEvaluateResponse -> nat.front_ends.fastapi.fastapi_front_end_config.EvaluateResponse

  • aiq.front_ends.fastapi.fastapi_front_end_config.AIQAsyncGenerateResponse -> nat.front_ends.fastapi.fastapi_front_end_config.AsyncGenerateResponse

  • aiq.front_ends.fastapi.fastapi_front_end_config.AIQEvaluateStatusResponse -> nat.front_ends.fastapi.fastapi_front_end_config.EvaluateStatusResponse

  • aiq.front_ends.fastapi.fastapi_front_end_config.AIQAsyncGenerationStatusResponse -> nat.front_ends.fastapi.fastapi_front_end_config.AsyncGenerationStatusResponse

  • aiq.registry_handlers.schemas.publish.BuiltAIQArtifact -> nat.registry_handlers.schemas.publish.BuiltArtifact

  • aiq.registry_handlers.schemas.publish.AIQArtifact -> nat.registry_handlers.schemas.publish.Artifact

  • aiq.retriever.interface.AIQRetriever -> nat.retriever.interface.Retriever

  • aiq.retriever.models.AIQDocument -> nat.retriever.models.Document

  • aiq.runtime.runner.AIQRunnerState -> nat.runtime.runner.RunnerState

  • aiq.runtime.runner.AIQRunner -> nat.runtime.runner.Runner

  • aiq.runtime.session.AIQSessionManager -> nat.runtime.session.SessionManager

  • aiq.tool.retriever.AIQRetrieverConfig -> nat.tool.retriever.RetrieverConfig

• Functions and decorators which previously contained aiq_ have had aiq removed. Compatibility aliases are in place to ensure backwards compatibility.

  • aiq.experimental.decorators.experimental_warning_decorator.aiq_experimental() -> nat.experimental.decorators.experimental_warning_decorator.experimental()

  • aiq.registry_handlers.package_utils.build_aiq_artifact() -> nat.registry_handlers.package_utils.build_artifact()

  • aiq.runtime.loader.get_all_aiq_entrypoints_distro_mapping() -> nat.runtime.loader.get_all_entrypoints_distro_mapping()

  • aiq.tool.retriever.aiq_retriever_tool() -> nat.tool.retriever.retriever_tool()

v1.1.0

Package Changes

• The agentiq package has been renamed to aiqtoolkit.

Warning

agentiq will be removed in a future release and is published as a transitional package.