"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {string} */
orderBy;
/** @type {string} */
orderByDesc;
/** @type {string} */
include;
/** @type {string} */
fields;
/** @type {{ [index:string]: string; }} */
meta;
}
/** @typedef T {any} */
export class QueryDb extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AuditBase {
/** @param {{createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
createdDate;
/** @type {string} */
createdBy;
/** @type {string} */
modifiedDate;
/** @type {string} */
modifiedBy;
/** @type {?string} */
deletedDate;
/** @type {string} */
deletedBy;
}
export class Artist extends AuditBase {
/** @param {{id?:number,firstName?:string,lastName?:string,yearDied?:number,type?:string[],score?:number,rank?:number,createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
id;
/** @type {?string} */
firstName;
/** @type {string} */
lastName;
/** @type {?number} */
yearDied;
/** @type {?string[]} */
type;
/** @type {number} */
score;
/** @type {number} */
rank;
}
export class CreativeArtist {
/** @param {{id?:number,creativeId?:number,artistId?:number,artist?:Artist}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
creativeId;
/** @type {number} */
artistId;
/** @type {Artist} */
artist;
}
export class Modifier extends AuditBase {
/** @param {{id?:number,name?:string,category?:string,description?:string,score?:number,rank?:number,createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
name;
/** @type {string} */
category;
/** @type {?string} */
description;
/** @type {number} */
score;
/** @type {number} */
rank;
}
export class CreativeModifier {
/** @param {{id?:number,creativeId?:number,modifierId?:number,modifier?:Modifier}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
creativeId;
/** @type {number} */
modifierId;
/** @type {Modifier} */
modifier;
}
export class Artifact extends AuditBase {
/** @param {{id?:number,creativeId?:number,fileName?:string,filePath?:string,contentType?:string,contentLength?:number,width?:number,height?:number,seed?:number,prompt?:string,nsfw?:boolean,averageHash?:number,perceptualHash?:number,differenceHash?:number,background?:string,lqip?:string,quality?:number,likesCount?:number,albumsCount?:number,downloadsCount?:number,searchCount?:number,temporalScore?:number,score?:number,rank?:number,refId?:string,versions?:{ [index:string]: string; },createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
creativeId;
/** @type {string} */
fileName;
/** @type {string} */
filePath;
/** @type {string} */
contentType;
/** @type {number} */
contentLength;
/** @type {number} */
width;
/** @type {number} */
height;
/** @type {number} */
seed;
/** @type {string} */
prompt;
/** @type {?boolean} */
nsfw;
/** @type {?number} */
averageHash;
/** @type {?number} */
perceptualHash;
/** @type {?number} */
differenceHash;
/** @type {?string} */
background;
/** @type {?string} */
lqip;
/** @type {number} */
quality;
/** @type {number} */
likesCount;
/** @type {number} */
albumsCount;
/** @type {number} */
downloadsCount;
/** @type {number} */
searchCount;
/** @type {number} */
temporalScore;
/** @type {number} */
score;
/** @type {number} */
rank;
/** @type {string} */
refId;
/** @type {{ [index:string]: string; }} */
versions = {};
}
export class Creative extends AuditBase {
/** @param {{id?:number,userPrompt?:string,prompt?:string,images?:number,width?:number,height?:number,steps?:number,curatedArtifactId?:number,primaryArtifactId?:number,artistNames?:string[],modifierNames?:string[],artists?:CreativeArtist[],modifiers?:CreativeModifier[],artifacts?:Artifact[],error?:string,ownerId?:number,ownerRef?:string,key?:string,curated?:boolean,rating?:number,private?:boolean,score?:number,rank?:number,refId?:string,requestId?:string,engineId?:string,createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
userPrompt;
/** @type {string} */
prompt;
/** @type {number} */
images;
/** @type {number} */
width;
/** @type {number} */
height;
/** @type {number} */
steps;
/** @type {?number} */
curatedArtifactId;
/** @type {?number} */
primaryArtifactId;
/** @type {string[]} */
artistNames = [];
/** @type {string[]} */
modifierNames = [];
/** @type {CreativeArtist[]} */
artists = [];
/** @type {CreativeModifier[]} */
modifiers = [];
/** @type {Artifact[]} */
artifacts = [];
/** @type {?string} */
error;
/** @type {?number} */
ownerId;
/** @type {?string} */
ownerRef;
/** @type {?string} */
key;
/** @type {boolean} */
curated;
/** @type {?number} */
rating;
/** @type {boolean} */
private;
/** @type {number} */
score;
/** @type {number} */
rank;
/** @type {string} */
refId;
/** @type {string} */
requestId;
/** @type {string} */
engineId;
}
export class QueryCreatives extends QueryDb {
/** @param {{id?:number,createdBy?:string,ownerId?:number,skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
id;
/** @type {?string} */
createdBy;
/** @type {?number} */
ownerId;
}
export class ArtifactResult extends Artifact {
/** @param {{userPrompt?:string,artistNames?:string[],modifierNames?:string[],primaryArtifactId?:number,ownerRef?:string,similarity?:number,id?:number,creativeId?:number,fileName?:string,filePath?:string,contentType?:string,contentLength?:number,width?:number,height?:number,seed?:number,prompt?:string,nsfw?:boolean,averageHash?:number,perceptualHash?:number,differenceHash?:number,background?:string,lqip?:string,quality?:number,likesCount?:number,albumsCount?:number,downloadsCount?:number,searchCount?:number,temporalScore?:number,score?:number,rank?:number,refId?:string,versions?:{ [index:string]: string; },createdDate?:string,createdBy?:string,modifiedDate?:string,modifiedBy?:string,deletedDate?:string,deletedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
userPrompt;
/** @type {string[]} */
artistNames = [];
/** @type {string[]} */
modifierNames = [];
/** @type {?number} */
primaryArtifactId;
/** @type {string} */
ownerRef;
/** @type {?number} */
similarity;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index:string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results;
/** @type {{ [index:string]: string; }} */
meta;
/** @type {ResponseStatus} */
responseStatus;
}
JavaScript QueryCreatives DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/QueryCreatives HTTP/1.1
Host: blazordiffusion.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<QueryCreatives xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlazorDiffusion.ServiceModel">
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<CreatedBy>String</CreatedBy>
<Id>0</Id>
<OwnerId>0</OwnerId>
</QueryCreatives>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfCreative55quYL7_S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BlazorDiffusion.ServiceModel">
<d2p1:Creative>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CreatedBy>String</CreatedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<ModifiedBy>String</ModifiedBy>
<DeletedDate>0001-01-01T00:00:00</DeletedDate>
<DeletedBy>String</DeletedBy>
<d2p1:Artifacts>
<d2p1:Artifact>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CreatedBy>String</CreatedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<ModifiedBy>String</ModifiedBy>
<DeletedDate>0001-01-01T00:00:00</DeletedDate>
<DeletedBy>String</DeletedBy>
<d2p1:AlbumsCount>0</d2p1:AlbumsCount>
<d2p1:AverageHash>0</d2p1:AverageHash>
<d2p1:Background>String</d2p1:Background>
<d2p1:ContentLength>0</d2p1:ContentLength>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:CreativeId>0</d2p1:CreativeId>
<d2p1:DifferenceHash>0</d2p1:DifferenceHash>
<d2p1:DownloadsCount>0</d2p1:DownloadsCount>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FilePath>String</d2p1:FilePath>
<d2p1:Height>0</d2p1:Height>
<d2p1:Id>0</d2p1:Id>
<d2p1:LikesCount>0</d2p1:LikesCount>
<d2p1:Lqip>String</d2p1:Lqip>
<d2p1:Nsfw>false</d2p1:Nsfw>
<d2p1:PerceptualHash>0</d2p1:PerceptualHash>
<d2p1:Prompt>String</d2p1:Prompt>
<d2p1:Quality>0</d2p1:Quality>
<d2p1:Rank>0</d2p1:Rank>
<d2p1:RefId>String</d2p1:RefId>
<d2p1:Score>0</d2p1:Score>
<d2p1:SearchCount>0</d2p1:SearchCount>
<d2p1:Seed>0</d2p1:Seed>
<d2p1:TemporalScore>0</d2p1:TemporalScore>
<d2p1:Versions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d2p1:Versions>
<d2p1:Width>0</d2p1:Width>
</d2p1:Artifact>
</d2p1:Artifacts>
<d2p1:ArtistNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:ArtistNames>
<d2p1:Artists>
<d2p1:CreativeArtist>
<d2p1:Artist>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CreatedBy>String</CreatedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<ModifiedBy>String</ModifiedBy>
<DeletedDate>0001-01-01T00:00:00</DeletedDate>
<DeletedBy>String</DeletedBy>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:Id>0</d2p1:Id>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:Rank>0</d2p1:Rank>
<d2p1:Score>0</d2p1:Score>
<d2p1:Type xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</d2p1:Type>
<d2p1:YearDied>0</d2p1:YearDied>
</d2p1:Artist>
<d2p1:ArtistId>0</d2p1:ArtistId>
<d2p1:CreativeId>0</d2p1:CreativeId>
<d2p1:Id>0</d2p1:Id>
</d2p1:CreativeArtist>
</d2p1:Artists>
<d2p1:Curated>false</d2p1:Curated>
<d2p1:CuratedArtifactId>0</d2p1:CuratedArtifactId>
<d2p1:EngineId>String</d2p1:EngineId>
<d2p1:Error>String</d2p1:Error>
<d2p1:Height>0</d2p1:Height>
<d2p1:Id>0</d2p1:Id>
<d2p1:Images>0</d2p1:Images>
<d2p1:Key>String</d2p1:Key>
<d2p1:ModifierNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:ModifierNames>
<d2p1:Modifiers>
<d2p1:CreativeModifier>
<d2p1:CreativeId>0</d2p1:CreativeId>
<d2p1:Id>0</d2p1:Id>
<d2p1:Modifier>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CreatedBy>String</CreatedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<ModifiedBy>String</ModifiedBy>
<DeletedDate>0001-01-01T00:00:00</DeletedDate>
<DeletedBy>String</DeletedBy>
<d2p1:Category>String</d2p1:Category>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:Rank>0</d2p1:Rank>
<d2p1:Score>0</d2p1:Score>
</d2p1:Modifier>
<d2p1:ModifierId>0</d2p1:ModifierId>
</d2p1:CreativeModifier>
</d2p1:Modifiers>
<d2p1:OwnerId>0</d2p1:OwnerId>
<d2p1:OwnerRef>String</d2p1:OwnerRef>
<d2p1:PrimaryArtifactId>0</d2p1:PrimaryArtifactId>
<d2p1:Private>false</d2p1:Private>
<d2p1:Prompt>String</d2p1:Prompt>
<d2p1:Rank>0</d2p1:Rank>
<d2p1:Rating>0</d2p1:Rating>
<d2p1:RefId>String</d2p1:RefId>
<d2p1:RequestId>String</d2p1:RequestId>
<d2p1:Score>0</d2p1:Score>
<d2p1:Steps>0</d2p1:Steps>
<d2p1:UserPrompt>String</d2p1:UserPrompt>
<d2p1:Width>0</d2p1:Width>
</d2p1:Creative>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfCreative55quYL7_S>