Get similar feedback records

client.feedbackRecords.retrieveSimilar(, ?, ?): FeedbackRecordRetrieveSimilarResponse { data, limit, next_cursor }

GET/v1/feedback-records/{id}/similar

Returns feedback record IDs and similarity scores for records similar to the given one (by embedding). Only available when embeddings are configured (EMBEDDING_PROVIDER and EMBEDDING_MODEL set). Supported providers: openai, google (Gemini Developer API / Google AI Studio), google-gemini (Gemini Enterprise Agent Platform API). When embeddings are disabled, this endpoint returns 503 Service Unavailable. Hub derives the tenant from the source feedback record and scopes the nearest-neighbor search to that tenant.

ParametersExpand Collapse

id: string

formatuuid

query: FeedbackRecordRetrieveSimilarParams { cursor, limit, min_score }

cursor?: string

Omit for the first page. For the next page, use the exact value from the previous response's next_cursor. Opaque (base64-encoded); keyset pagination.

limit?: number

Number of results to return (default 10, max 100). Consistent with list endpoints.

minimum1

maximum100

min_score?: number

Minimum similarity score (0..1); only results with score >= min_score are returned. Default 0.7 to reduce noise.

formatfloat

minimum0

maximum1

ReturnsExpand Collapse

FeedbackRecordRetrieveSimilarResponse { data, limit, next_cursor }

data: Array<Data>

List of feedback record IDs with similarity scores (0 = unrelated, 1 = identical). Consistent with list endpoints.

feedback_record_id: string

Feedback record UUID

formatuuid

field_label: string

Label of the feedback field (included in embedding for context). May be empty if the source record had no label.

score: number

Similarity score (0..1)

formatdouble

value_text: string

value_text of the feedback record (the text that was embedded). May be empty if the source had no text; embeddings are only created for records with non-empty value_text, but the field can be cleared after embedding creation.

limit: number

Limit used in query (echoed for consistency with list endpoints)

next_cursor?: string

Opaque cursor for the next page (keyset paging). Present only when there may be more results (full page returned). Omit when no next page. Use this exact value as the cursor query param for the next page.

Get similar feedback records

import FormbricksHub from '@formbricks/hub';

const client = new FormbricksHub({
  apiKey: process.env['HUB_API_KEY'], // This is the default and can be omitted
});

const response = await client.feedbackRecords.retrieveSimilar(
  '018e1234-5678-9abc-def0-123456789abc',
);

console.log(response.data);

{
  "data": [
    {
      "feedback_record_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "field_label": "field_label",
      "score": 0,
      "value_text": "value_text"
    }
  ],
  "limit": 0,
  "next_cursor": "eyJkIjowLjEsImkiOiIwMThlMTIzNC01Njc4LTlhYmMtZGVmMC0xMTExMTExMTExMTEifQ=="
}

Returns Examples

{
  "data": [
    {
      "feedback_record_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "field_label": "field_label",
      "score": 0,
      "value_text": "value_text"
    }
  ],
  "limit": 0,
  "next_cursor": "eyJkIjowLjEsImkiOiIwMThlMTIzNC01Njc4LTlhYmMtZGVmMC0xMTExMTExMTExMTEifQ=="
}