EnterpriseTopazSidekickCardMetadata

import type { EnterpriseTopazSidekickCardMetadata } from "https://googleapis.deno.dev/v1/cloudsearch:v1.ts";

Card metadata.

interface EnterpriseTopazSidekickCardMetadata {

cardCategory?:

| "DEFAULT"

| "ANSWER"

| "KNOWLEDGE"

| "HOMEPAGE";

cardId?: string;

chronology?:

| "UNKNOWN"

| "PAST"

| "RECENTLY_PAST"

| "PRESENT"

| "NEAR_FUTURE"

| "FUTURE";

debugInfo?: string;

nlpMetadata?: EnterpriseTopazSidekickNlpMetadata;

rankingParams?: EnterpriseTopazSidekickRankingParams;

renderMode?: "UNKNOWN_RENDER" | "COLLAPSED" | "EXPANDED";

}

§Properties

cardCategory?: "DEFAULT" | "ANSWER" | "KNOWLEDGE" | "HOMEPAGE"

[src]

Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped.

cardId?: string

[src]

An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards.

[src]

Chronology.

debugInfo?: string

[src]

Debug info (only reported if request's debug_level > 0).

nlpMetadata?: EnterpriseTopazSidekickNlpMetadata

[src]

Information about the NLP done to get the card.

rankingParams?: EnterpriseTopazSidekickRankingParams

[src]

Ranking params.

renderMode?: "UNKNOWN_RENDER" | "COLLAPSED" | "EXPANDED"

[src]

Render mode.