Skip to content

HYBIM-802 Updated utils APIs#348

Open
wrisa wants to merge 2 commits into
mainfrom
update-utils-APIs-to-match-upstream
Open

HYBIM-802 Updated utils APIs#348
wrisa wants to merge 2 commits into
mainfrom
update-utils-APIs-to-match-upstream

Conversation

@wrisa

@wrisa wrisa commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

To match new upstream APIs,
added
inference, embedding, tool, workflow

deprecated

start_inference
start_embedding
start_tool
start_workflow

Note:
Not deprecating start_agent and adding invoke_local_agent similar to upstream becaset hese are not a direct equivalent. The splunk-distro start_agent accepts AgentCreation | AgentInvocation (supports two types) and does more work (context stack, conversation root marking, etc.), while the upstream invoke_local_agent is specifically for AgentInvocation with SpanKind.INTERNAL.

wrisa and others added 2 commits June 16, 2026 13:39
Wrap long line in test_embedding_context_manager to satisfy ruff format check.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@wrisa wrisa changed the title Updated utils APIs HYBIM-802 Updated utils APIs Jun 17, 2026
@wrisa wrisa marked this pull request as ready for review June 17, 2026 16:55
@wrisa wrisa requested review from a team as code owners June 17, 2026 16:55

@keith-decker keith-decker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only one non blocking note from codex:

The PR changes public API guidance by marking the start_* factory methods deprecated in favor of the shorter aliases, but the package changelog's [Unreleased] section does not mention that API transition. Prior handler API work in PR 293 updated this changelog, so adding a short Changed entry would make the release notes match the public surface change.


# -- Deprecated lifecycle methods ----------------------------------------
# The following methods are preserved for backward compatibility.
# Prefer the new factory methods (start_inference, start_tool, etc.)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment from previous PR doesn't apply any more

server_port=server_port,
)

def _start_embedding_factory(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This becomes dead code and could be removed

tool_description=tool_description,
)

def _start_workflow_factory(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This becomes dead code as well, can be removed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants