v1.9: Update telemetry table

[guimachiavelli]

As title.

@curquiza, did you happen to make that document summarising which v1.9 updates have added/removed telemetry data points?

[guimachiavelli]

rankingScoreThreshold

Name	Description	Example
scoring.ranking_score_threshold	Boolean indicating whether a rankingScoreThreshold was specified in an aggregated list of requests	true

[guimachiavelli]

/similar

This endpoint adds new data points, but I don't have enough information at the moment. Pinging @macraig.

From the PRD:

This feature adds two new telemetry events:

• Similar GET
• Similar POST

The properties of these events are the same as those for the search events, but those that are not currently relevant (e.g., sort.*) will always be missing.

These events are aggregated similarly to the search events.

[guimachiavelli]

frequency matching strategy

frequency is now a possible value for the existing matching_strategy data point. No change required in the documentation.

[guimachiavelli]

distinct search parameter

Name	Description	Example
e.g. infos.log_level	e.g. “value of --log-level”	e.g. “debug”
distinct	Boolean indicating whether a distinct was specified in an aggregated list of requests.	true

[macraig]

/similar

This endpoint adds new data points, but I don't have enough information at the moment. Pinging @macraig.

From the PRD:

This feature adds two new telemetry events:

• Similar GET
• Similar POST

The properties of these events are the same as those for the search events, but those that are not currently relevant (e.g., sort.*) will always be missing. These events are aggregated similarly to the search events.

@guimachiavelli what kind of info are you missing?

[curquiza]

Sorry gui!

• distinct attribute at search
• hybrid search
• filter by score
• get similar documents
• anything about puffin exp feature in the telemetry (if there is any)
• frequency matching strategy

[guimachiavelli]

AI-powered search

Name	Description	Example
vector.retrieve_vectors	true if the retrieve_vectors has been used in this batch.	false

[guimachiavelli]

@macraig, a table like the one we had for distinct or retrieve_vectors would be ideal. Or is that not applicable to /similar?

[macraig]

@guimachiavelli oh I see what you mean. I think it might not be applicable because we're only adding the /similar endpoint. It should have the same properties as /search but no other new properties, I'll ping @dureuill to confirm.

[dureuill]

For the purpose of the telemetry page in the docs, there is nothing to add for similar, because it reuses all the event names of the search routes.

If there is another page that lists events per route, then we need to add all the same events for the similar route as for the search route.

[guimachiavelli]

Thanks for the input, everyone. This is the final summary of v1.9 updates to the telemetry page in the docs:

Name	Description	Example
vector.retrieve_vectors	true if the retrieve_vectors has been used in this batch.	false
distinct	Boolean indicating whether a distinct was specified in an aggregated list of requests.	true
scoring.ranking_score_threshold	Boolean indicating whether a rankingScoreThreshold was specified in an aggregated list of requests	true