[Obs AI Assistant] Rename chat completion methods to align with LLM vendor terminology

[sorenlouv]

Problem

The Obs AI Assistant exposes two chat completion methods: chat and complete. These names don't accurately describe their behaviour and does not align with LLM vendor terminology. This makes it more difficult when getting started working with the AI Assistant as a developer

The primary difference between the two methods is that:

• chat only calls chat completion API once
• complete resolves function (tool) requests and will therefore recursively call the chat completion API. It does this by calling chat under the hood.

Solution

• Rename chat to chatCompletion.
• Rename complete to runTools

LLM Terminology

• Hugging face calls it "chat completion"
• OpenAI calls it chat completion and run tools

API endpoints

We should also consider renaming the API endpoints:

• POST /internal/observability_ai_assistant/chat to POST /internal/observability_ai_assistant/chat/completion
• POST /internal/observability_ai_assistant/chat/complete to /internal/observability_ai_assistant/chat/completion/run_tools
• POST /api/observability_ai_assistant/chat/complete to /api/observability_ai_assistant/chat/run_tools

[elasticmachine]

Pinging @elastic/obs-ai-assistant (Team:Obs AI Assistant)

[dgieselaar]

OpenAI calls this runTools (which I would personally prefer over recursiveChatCompletion) https://github.com/openai/openai-node#automated-function-calls

[sorenlouv]

OpenAI calls this runTools (which I would personally prefer over recursiveChatCompletion) https://github.com/openai/openai-node#automated-function-calls

@dgieselaar I agree. recursiveChatCompletion didn't feel quite right. Personally I'd prefer something that clearly indicates that it does chat completion like chatCompletionWithTools. That being said, I'd rather use the industry terms than inventing our own so I'm good with runTools

[sorenlouv]

Handing this over to @viduni94 since she is already working on it

[viduni94]

Handing this over to @viduni94 since she is already working on it

Thank you @sorenlouv
I'll take this over.

[viduni94]

Before publishing the docs for our public chat complete API, we need to make sure that the properties and API endpoint conform with up to date terminology.

For example:

• We have API params named function_call, which needs to be renamed to tool_call
• And all references to function needs to be renamed to tool

Relates to https://github.com/elastic/obs-ai-assistant-team/issues/193
Draft PR for the public API documentation - #206869