Skip to main content

AiReviewColumnSuggestion

A column the model proposes from the reviewer's description. Nothing is persisted: the reviewer keeps what they want and the client calls addAiReviewColumn for each one, so a suggestion has no key, no state and no id.

type AiReviewColumnSuggestion {
  label: String!
  prompt: String!
  type: AiReviewFieldType!
  options: [String!]
  unit: String
}

Fields​

AiReviewColumnSuggestion.label ● String! non-null scalar​

The column header.

AiReviewColumnSuggestion.prompt ● String! non-null scalar​

The extraction question, phrased so one document answers it on its own. A question that compares documents cannot be answered cell by cell.

AiReviewColumnSuggestion.type ● AiReviewFieldType! non-null enum​

AiReviewColumnSuggestion.options ● [String!] list scalar​

Non-null and non-empty only for SINGLE_SELECT and MULTI_SELECT. A select suggestion that arrived without options is dropped rather than offered.

AiReviewColumnSuggestion.unit ● String scalar​

ISO code for CURRENCY, a unit label for NUMBER, a date format for DATE. Null for every other type.

Member Of​

BuildAiReviewColumnsPayload object