Skip to content

feat(specs): add draft schema for Agentic Analytics#6167

Draft
sirockin wants to merge 17 commits intomainfrom
vnts-121-draft-schema-for-agentic-analytics
Draft

feat(specs): add draft schema for Agentic Analytics#6167
sirockin wants to merge 17 commits intomainfrom
vnts-121-draft-schema-for-agentic-analytics

Conversation

@sirockin
Copy link
Copy Markdown
Contributor

@sirockin sirockin commented Mar 27, 2026

DO NOT MERGE - FOR DISCUSSION ONLY

JIRA Ticket: https://algolia.atlassian.net/browse/VNTS-136

This PR is provided for discussion purposes to capture Agentic Analytics requirements extensions to the insights API event schema.

It should not introduce any breaking changes but before publishing publicly we will treat the extensions as internal until testing has been completed.

Bundlers and linters tend to introduce whitespace changes so I recommend viewing changes with 'View Whitespace' turned off in settings.

Please comment on the source docs in specs/insights/ rather than the bundled specs.

To view the resulting API in swagger doc, pull this branch then:

Start server:

docker run --rm --name insights-swagger -p 8080:8080 -e SWAGGER_JSON=/spec/bundled.yml -v /Users/dave.sirockin/src/github.com/algolia/api-clients-automation/specs/bundled/insights.yml:/spec/bundled.yml:ro swaggerapi/swagger-ui

Open browser to view UI docs at http://localhost:8080

Stop:

docker stop insights-swagger

@algolia-bot
Copy link
Copy Markdown
Collaborator

algolia-bot commented Mar 27, 2026

✔️ Code generated!

Name Link
🪓 Triggered by 9200f1278c364bf91d330643e9ea8505d86c1b58
🍃 Generated commit 84a7982467a1b49af6f7a393f9f2ad483859dab2
🌲 Generated branch generated/vnts-121-draft-schema-for-agentic-analytics
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 2645
go 1996
php 1697
csharp 1616
python 1342
java 1111
ruby 999
swift 362
scala 23

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 27, 2026

sessionID:
$ref: '#/components/schemas/sessionID'
index:
$ref: '#/components/schemas/index'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

if possible please remove the index here?
typically an event may use multiple indices.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

this is an artefact from the bundling process which seems a bit broken. I'll see if I can put a PR in to fix this. In the mean time please could you review the source files /specs/insights (I mentioned this in the PR description but it may not have been clear).

- agentID
- messageID
- toolCallID
- conversationID
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

this cannot work for us infortunately because events with only messageID should remain valid.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No problem. How about we make messageID required?

Copy link
Copy Markdown
Contributor Author

@sirockin sirockin Mar 30, 2026

Choose a reason for hiding this comment

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

Also please could you give us some more context about the use of messageID and conversationID?
Also a bit more context about when toolCallID and agentID would and wouldn't be used.
For example, I'd understood that a message was always part of a conversation.

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