Objects: Content generation

GraphQL object types for content generation, content flow, and content review in the Amplience GraphQL Management API.

Sessions & messages

SubmitContentGenerationSessionMessageResponse

Field	Type	Description
submittedMessage	ContentGenerationSessionMessage!
responseStreamUrl	String!

GenerateEditForContentGenerationSessionMessagePropertyResponse

Field	Type	Description
responseStreamUrl	String!

ContentGenerationSession

Implements: Node

Field	Type	Description
id	ID!
messages	[ContentGenerationSessionMessage]!
organization	Organization!
cmsHub	CMSHub!
briefTemplate	ContentGenerationBriefTemplate!
author	ContentGenerationSessionAuthor!
label	String!
createdDate	DateTime!
expiryDate	DateTime

ContentGenerationSessionAuthor

Field	Type	Description
user	User!

ContentGenerationSessionMessage

Implements: Node

Field	Type	Description
id	ID!
parent	ContentGenerationSessionMessage
status	ContentGenerationSessionMessageStatus!
author	ContentGenerationSessionMessageAuthor!
content	ContentGenerationSessionMessageContent!
createdDate	DateTime
expiryDate	DateTime

ContentGenerationSessionMessageAuthor

Field	Type	Description
role	ContentGenerationSessionMessageAuthorRole
user	User

ContentGenerationSessionMessageBriefContent

Field	Type	Description
briefInputs	String!
modelId	String!
exampleIds	[String]
images	[ContentGenerationSessionMessageBriefContentImage]

ContentGenerationSessionMessageBriefContentImage

Field	Type	Description
url	String!
originalUrl	String!
id	String!

ContentGenerationSessionMessageRawContentContent

Field	Type	Description
body	String!
scores	String

Briefs & templates

ContentGenerationBriefTemplate

Implements: Node

Field	Type	Description
id	ID!
defaultModel	ContentGenerationModel!
label	String!
description	String!
imageUrl	String
createdDate	DateTime!
updatedDate	DateTime!
createdBy	User
updatedBy	User
category	String!
roles	[String!]!
status	ContentGenerationBriefTemplateStatus!
inputSchema	String!
outputSchema	String!
configuration	ContentGenerationBriefTemplateConfiguration
cmsHub	CMSHub
organization	Organization

ContentGenerationBriefTemplateConfiguration

Field	Type	Description
inputFields	[ContentGenerationBriefTemplateField]!
instructions	String!

ContentGenerationBriefTemplateImageField

Implements: ContentGenerationBriefTemplateField

Field	Type	Description
label	String!
name	String!

ContentGenerationBriefTemplateKeyValueField

Implements: ContentGenerationBriefTemplateField

Field	Type	Description
label	String!
name	String!

ContentGenerationBriefTemplateTextField

Implements: ContentGenerationBriefTemplateField

Field	Type	Description
label	String!
name	String!
format	ContentGenerationBriefTemplateTextFieldFormat!

Audiences, brand voices & tones

ContentGenerationAudience

Implements: Node

Field	Type	Description
id	ID!
label	String!
ageRangeMin	Int!
ageRangeMax	Int!
gender	String!
description	String

ContentGenerationTone

Implements: Node

Field	Type	Description
id	ID!
label	String!
description	String!

ContentGenerationBrandVoice

Implements: Node

Field	Type	Description
id	ID!
label	String!
brandName	String
locale	ContentGenerationBrandVoiceLocale!
tone	ContentGenerationTone
brandValues	[ContentGenerationBrandVoiceValue]!
brandRuleExclusions	[String]!
brandRuleSubstitutions	[ContentGenerationBrandVoiceRuleSubstitution]!
contentGenerationExampleFolders	ContentGenerationExampleFolder Connection!	Args: before: String, after: String, first: Int, last: Int, briefTemplateId: ID!
contentGenerationExamples	ContentGenerationExample Connection!	Args: briefTemplateId: ID!, before: String, after: String, first: Int, last: Int

ContentGenerationBrandVoiceRuleSubstitution

Field	Type	Description
term	String!
substitute	String!

ContentGenerationBrandVoiceValue

Field	Type	Description
label	String!
description	String!

Examples

ContentGenerationExample

Implements: Node

Field	Type	Description
id	ID!
organization	Organization!
cmsHub	CMSHub!
briefTemplate	ContentGenerationBriefTemplate!
brandVoice	ContentGenerationBrandVoice!
label	String!
createdDate	DateTime!
briefInputs	String!
folder	ContentGenerationExampleFolder
output	String!

ContentGenerationExampleFolder

Implements: Node

Field	Type	Description
id	ID!
label	String!
createdDate	String
brandVoice	ContentGenerationBrandVoice!
briefTemplate	ContentGenerationBriefTemplate!
parent	ContentGenerationExampleFolder
subFolders	ContentGenerationExampleFolder Connection!	Args: before: String, after: String, first: Int, last: Int
examples	ContentGenerationExample Connection!	Args: before: String, after: String, first: Int, last: Int

Jobs & models

HubContentGenerationModel

Field	Type	Description
model	ContentGenerationModel!
enabled	Boolean!

InputModalities

Field	Type	Description
image	Boolean!

OutputModalities

Field	Type	Description
text	TextOutputModality!
structuredOutputs	StructuredOutputModality!

StructuredOutputModality

Field	Type	Description
supported	Boolean!

TextOutputModality

Field	Type	Description
supported	Boolean!

ContentGenerationJob

Implements: Node

Field	Type	Description
id	ID!
status	ContentGenerationJobStatus!
author	ContentGenerationJobAuthor!
briefContent	ContentGenerationJobBriefContent!
content	String
createdDate	DateTime!
expiryDate	DateTime!

ContentGenerationJobAuthor

Field	Type	Description
user	User

ContentGenerationJobBriefContent

Field	Type	Description
briefInputs	String!
modelId	String!
exampleIds	[String]
images	[ContentGenerationJobBriefContentImage]

ContentGenerationJobBriefContentImage

Field	Type	Description
url	String!
originalUrl	String!
id	String!

ContentGenerationJobStatus

Field	Type	Description
code	ContentGenerationJobStatusCode!
message	String

ContentGenerationModel

Implements: Node

Field	Type	Description
id	ID!
label	String!
description	String!
inputModalities	InputModalities!
outputModalities	OutputModalities!
lifecycle	ContentGenerationModelLifecycle!
provider	Provider!
enabled	Boolean!	Args: cmsHubId: ID!

ContentGenerationModelLifecycle

Field	Type	Description
stage	ContentGenerationModelLifecycleStage!
retirementDate	DateTime

Text & SEO generation

RichTextGenerationTicket

Field	Type	Description
id	String!
url	String!

SEOGenerationResponse

Field	Type	Description
variants	[String!]!

Content flow

ContentFlow

Implements: Node

Field	Type	Description
id	ID!
runs	ContentFlowRunConnection!	Args: before: String, after: String, first: Int, last: Int
label	String!
description	String!
status	ContentFlowStatus!
flow	String!
cmsHub	CMSHub!
organization	Organization!
createdDate	DateTime!
updatedDate	DateTime!
lastRunDate	DateTime

ContentFlowActionErrorEvent

Implements: ContentFlowRunEvent

Field	Type	Description
eventId	ID!
createdDate	DateTime!
sequence	Int!
actionId	String!
message	String!

ContentFlowErrorEvent

Implements: ContentFlowRunEvent

Field	Type	Description
eventId	ID!
createdDate	DateTime!
sequence	Int!
message	String!

ContentFlowRun

Implements: Node

Field	Type	Description
id	ID!
flow	ContentFlow!
flowSnapshot	String
label	String!
attributes	[ContentFlowRunAttribute!]!
tags	[String!]!
createdDate	DateTime!
updatedDate	DateTime!
status	ContentFlowRunStatus!
cmsHub	CMSHub!
organization	Organization!
events	ContentFlowRunEvent Connection!	Args: before: String, after: String, first: Int, last: Int

ContentFlowRunActionInvokeEvent

Implements: ContentFlowRunEvent

Field	Type	Description
eventId	ID!
createdDate	DateTime!
sequence	Int!
action	String!
actionId	String!
messages	String!

ContentFlowRunActionResultEvent

Implements: ContentFlowRunEvent

Field	Type	Description
eventId	ID!
createdDate	DateTime!
sequence	Int!
actionId	String!
inMessages	String!
outMessages	String!

ContentFlowRunAttribute

Field	Type	Description
key	String!
value	String!

ContentFlowRunStatusChangedEvent

Implements: ContentFlowRunEvent

Field	Type	Description
eventId	ID!
createdDate	DateTime!
sequence	Int!
previousStatus	ContentFlowRunStatus!
newStatus	ContentFlowRunStatus!

Content review

ContentReview

Implements: Node

Field	Type	Description
id	ID!
reviewTask	ContentReviewTask!
type	ContentReviewType!
createdBy	User!
createdDate	DateTime!
comment	String
suggestedBody	ContentReviewTaskBody

ContentReviewTask

Implements: Node

Field	Type	Description
id	ID!
label	String!
description	String!
status	ContentReviewTaskStatus!
attributes	[ContentReviewTaskAttribute]!
tags	[String]!
reviewers	[ContentReviewTaskReviewer]!
body	ContentReviewTaskBody!
cmsHub	CMSHub!
organization	Organization!
createdDate	DateTime!
updatedDate	DateTime!
expiryDate	DateTime!
dueDate	DateTime
contentReviews	[ContentReview]

ContentReviewTaskAttribute

Field	Type	Description
key	String!
value	String!
node	Node

ContentReviewTaskJsonBody

Field	Type	Description
value	String!
schema	String!

SubmitContentReviewResponse

Field	Type	Description
id	ID!

ContentReviewTaskAttributeFacetData

Field	Type	Description
facetName	String!
data	[ContentReviewTaskAttributeFacetDataGroup!]

ContentReviewTaskAttributeFacetDataGroup

Field	Type	Description
group	String!
data	[ContentReviewTaskAttributeFacetDataGroupEntry!]

ContentReviewTaskAttributeFacetDataGroupEntry

Field	Type	Description
value	String!
count	Int!
node	Node

ContentReviewTaskFacets

Field	Type	Description
totalReviewTasks	Int!
facets	[ContentReviewTaskFacet!]

ContentReviewTaskReviewerFacetData

Field	Type	Description
facetName	String!
data	[ContentReviewTaskReviewerFacetDataEntry!]

ContentReviewTaskReviewerFacetDataEntry

Field	Type	Description
reviewer	ContentReviewTaskReviewer!
count	Int!

ContentReviewTaskSearchResultMatch

Field	Type	Description
path	String!

ContentReviewTaskStatusFacetData

Field	Type	Description
facetName	String!
data	[ContentReviewTaskStatusFacetDataEntry!]

ContentReviewTaskStatusFacetDataEntry

Field	Type	Description
status	String!
count	Int!