guidelineDetails

Examples

type GuidelineDetails {
  _id: String!
  oxGuidelineId: String
  languages: [GuidelineLanguage!]!
  displayName: String!
  description: String
  prompt: String!
  promptSections: [PromptSectionResponse!]
  activationCriteria: String!
  activationCriteriaDefinition: ActivationCriteriaDefinitionResponse
  status: GuidelineStatus!
  isEditable: Boolean!
  createdBy: String!
  createdAt: DateTime!
  updatedBy: String!
  updatedAt: DateTime!
  category: CategoryId!
  isDeleted: Boolean!
  isReady: Boolean!
  examplePrompt: String
}

Fields

Field	Description	Supported fields
_id String!	Guideline ID
oxGuidelineId String	OX Guideline ID (if this is an OX guideline)
languages [GuidelineLanguage!]!	Languages this guideline is applicable to
displayName String!	Display name of the guideline
description String	Description of the guideline
prompt String!	Prompt of the guideline as text
promptSections [PromptSectionResponse!]	Prompt of the guidelines as sections (future enhancement)	type PromptSectionType! value String! order Float!
activationCriteria String!	Activation criteria of the guideline
activationCriteriaDefinition ActivationCriteriaDefinitionResponse	Activation criteria definition of the guideline	displayName String! description String! category CategoryId!
status GuidelineStatus!	Status of the guideline (Enabled or Disabled)
isEditable Boolean!	Whether the guideline is editable
createdBy String!	User who created the guideline
createdAt DateTime!	Creation timestamp
updatedBy String!	User who last updated the guideline
updatedAt DateTime!	Last update timestamp
category CategoryId!	Category of the guideline
isDeleted Boolean!	Whether the guideline is deleted
isReady Boolean!	Whether the guideline is ready
examplePrompt String	Example prompt that the guideline should be triggered for

References

Queries using this object:

• <?> getGuidelineDetails