INPUT_OBJECT

FieldAiGeneralOptionsParams

What the AI uses to generate the value of an AI Smart Field: the prompt and the enabled data sources.

link GraphQL Schema definition

  • input FieldAiGeneralOptionsParams {
  • # Instruction the AI follows to generate the field value; it can contain
  • # placeholders for values of the record.
  • prompt: String!
  • # When true, the AI can use the data sources enabled below (web search, record
  • # data, related records and documents); when false, it uses none of them.
  • dataSourcesEnabled: Boolean!
  • # When true (and dataSourcesEnabled), the AI can search the web.
  • webSearchEnabled: Boolean!
  • # When true (and dataSourcesEnabled), the AI receives the field values of the
  • # record.
  • recordDataEnabled: Boolean!
  • # When true (and dataSourcesEnabled), the AI receives the related records listed
  • # in relatedRecords.
  • relatedRecordsEnabled: Boolean!
  • # Kinds of related records the AI receives, one item per kind.
  • relatedRecords: [FieldAiOptionsRelatedRecordParams!]!
  • # When true (and dataSourcesEnabled), the AI receives the documents attached to
  • # the record.
  • recordDocumentsEnabled: Boolean!
  • # Condition selecting which attached documents the AI receives; all when not set.
  • recordDocumentsFilter: FieldFilterParams
  • }

link Require by