Type Alias RecommendGroupsReqPayload

RecommendGroupsReqPayload: {
    filters?: ChunkFilter | null;
    group_size?: number | null;
    limit?: number | null;
    metadata?: unknown;
    negative_group_ids?: string[] | null;
    negative_group_tracking_ids?: string[] | null;
    positive_group_ids?: string[] | null;
    positive_group_tracking_ids?: string[] | null;
    recommend_type?: RecommendType | null;
    slim_chunks?: boolean | null;
    strategy?: RecommendationStrategy | null;
    user_id?: string | null;
}

Type declaration

  • Optionalfilters?: ChunkFilter | null
  • Optionalgroup_size?: number | null

    The number of chunks to fetch for each group. This is the number of chunks which will be returned in the response for each group. The default is 3. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to reduce latency due to content download and serialization.

  • Optionallimit?: number | null

    The number of groups to return. This is the number of groups which will be returned in the response. The default is 10.

  • Optionalmetadata?: unknown

    Metadata is any metadata you want to associate w/ the event that is created from this request

  • Optionalnegative_group_ids?: string[] | null

    The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.

  • Optionalnegative_group_tracking_ids?: string[] | null

    The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.

  • Optionalpositive_group_ids?: string[] | null

    The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.

  • Optionalpositive_group_tracking_ids?: string[] | null

    The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.

  • Optionalrecommend_type?: RecommendType | null
  • Optionalslim_chunks?: boolean | null

    Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false.

  • Optionalstrategy?: RecommendationStrategy | null
  • Optionaluser_id?: string | null

    The user_id is the id of the user who is making the request. This is used to track user interactions with the rrecommendation results.

Settings

Member Visibility