Blazor Diffusion

<back to all web services

QueryCreatives

Creatives

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public skip?: number;

    // @DataMember(Order=2)
    public take?: number;

    // @DataMember(Order=3)
    public orderBy: string;

    // @DataMember(Order=4)
    public orderByDesc: string;

    // @DataMember(Order=5)
    public include: string;

    // @DataMember(Order=6)
    public fields: string;

    // @DataMember(Order=7)
    public meta: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AuditBase
{
    // @DataMember(Order=1)
    public createdDate: string;

    // @DataMember(Order=2)
    // @Required()
    public createdBy: string;

    // @DataMember(Order=3)
    public modifiedDate: string;

    // @DataMember(Order=4)
    // @Required()
    public modifiedBy: string;

    // @DataMember(Order=5)
    public deletedDate?: string;

    // @DataMember(Order=6)
    public deletedBy: string;

    public constructor(init?: Partial<AuditBase>) { (Object as any).assign(this, init); }
}

export class Artist extends AuditBase
{
    public id: number;
    public firstName?: string;
    public lastName: string;
    public yearDied?: number;
    public type?: string[];
    public score: number;
    public rank: number;

    public constructor(init?: Partial<Artist>) { super(init); (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="HasRole(`Moderator`)")
export class CreativeArtist
{
    public id: number;
    // @References("typeof(BlazorDiffusion.ServiceModel.Creative)")
    public creativeId: number;

    // @References("typeof(BlazorDiffusion.ServiceModel.Artist)")
    public artistId: number;

    public artist: Artist;

    public constructor(init?: Partial<CreativeArtist>) { (Object as any).assign(this, init); }
}

export class Modifier extends AuditBase
{
    public id: number;
    public name: string;
    public category: string;
    public description?: string;
    public score: number;
    public rank: number;

    public constructor(init?: Partial<Modifier>) { super(init); (Object as any).assign(this, init); }
}

export class CreativeModifier
{
    public id: number;
    // @References("typeof(BlazorDiffusion.ServiceModel.Creative)")
    public creativeId: number;

    // @References("typeof(BlazorDiffusion.ServiceModel.Modifier)")
    public modifierId: number;

    public modifier: Modifier;

    public constructor(init?: Partial<CreativeModifier>) { (Object as any).assign(this, init); }
}

export class Artifact extends AuditBase
{
    public id: number;
    // @References("typeof(BlazorDiffusion.ServiceModel.Creative)")
    public creativeId: number;

    public fileName: string;
    public filePath: string;
    public contentType: string;
    public contentLength: number;
    public width: number;
    public height: number;
    public seed: number;
    public prompt: string;
    public nsfw?: boolean;
    public averageHash?: number;
    public perceptualHash?: number;
    public differenceHash?: number;
    public background?: string;
    public lqip?: string;
    public quality: number;
    public likesCount: number;
    public albumsCount: number;
    public downloadsCount: number;
    public searchCount: number;
    public temporalScore: number;
    public score: number;
    public rank: number;
    public refId: string;
    public versions: { [index:string]: string; } = {};

    public constructor(init?: Partial<Artifact>) { super(init); (Object as any).assign(this, init); }
}

export class Creative extends AuditBase
{
    public id: number;
    public userPrompt: string;
    public prompt: string;
    public images: number;
    public width: number;
    public height: number;
    public steps: number;
    public curatedArtifactId?: number;
    public primaryArtifactId?: number;
    public artistNames: string[] = [];
    public modifierNames: string[] = [];
    public artists: CreativeArtist[] = [];
    public modifiers: CreativeModifier[] = [];
    public artifacts: Artifact[] = [];
    public error?: string;
    public ownerId?: number;
    public ownerRef?: string;
    public key?: string;
    public curated: boolean;
    public rating?: number;
    public private: boolean;
    public score: number;
    public rank: number;
    public refId: string;
    public requestId: string;
    public engineId: string;

    public constructor(init?: Partial<Creative>) { super(init); (Object as any).assign(this, init); }
}

export class QueryCreatives extends QueryDb<Creative>
{
    public id?: number;
    public createdBy?: string;
    public ownerId?: number;

    public constructor(init?: Partial<QueryCreatives>) { super(init); (Object as any).assign(this, init); }
}

export class ArtifactResult extends Artifact
{
    public userPrompt: string;
    public artistNames: string[] = [];
    public modifierNames: string[] = [];
    public primaryArtifactId?: number;
    public ownerRef: string;
    public similarity?: number;

    public constructor(init?: Partial<ArtifactResult>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public offset: number;

    // @DataMember(Order=2)
    public total: number;

    // @DataMember(Order=3)
    public results: ArtifactResult[];

    // @DataMember(Order=4)
    public meta: { [index:string]: string; };

    // @DataMember(Order=5)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript QueryCreatives DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/QueryCreatives HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	createdBy: String,
	ownerId: 0,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			userPrompt: String,
			prompt: String,
			images: 0,
			width: 0,
			height: 0,
			steps: 0,
			curatedArtifactId: 0,
			primaryArtifactId: 0,
			artistNames: 
			[
				String
			],
			modifierNames: 
			[
				String
			],
			artists: 
			[
				{
					id: 0,
					creativeId: 0,
					artistId: 0,
					artist: 
					{
						id: 0,
						firstName: String,
						lastName: String,
						yearDied: 0,
						type: 
						[
							String
						],
						score: 0,
						rank: 0,
						createdDate: 0001-01-01,
						createdBy: String,
						modifiedDate: 0001-01-01,
						modifiedBy: String,
						deletedDate: 0001-01-01,
						deletedBy: String
					}
				}
			],
			modifiers: 
			[
				{
					id: 0,
					creativeId: 0,
					modifierId: 0,
					modifier: 
					{
						id: 0,
						name: String,
						category: String,
						description: String,
						score: 0,
						rank: 0,
						createdDate: 0001-01-01,
						createdBy: String,
						modifiedDate: 0001-01-01,
						modifiedBy: String,
						deletedDate: 0001-01-01,
						deletedBy: String
					}
				}
			],
			artifacts: 
			[
				{
					id: 0,
					creativeId: 0,
					fileName: String,
					filePath: String,
					contentType: String,
					contentLength: 0,
					width: 0,
					height: 0,
					seed: 0,
					prompt: String,
					nsfw: False,
					averageHash: 0,
					perceptualHash: 0,
					differenceHash: 0,
					background: String,
					lqip: String,
					quality: 0,
					likesCount: 0,
					albumsCount: 0,
					downloadsCount: 0,
					searchCount: 0,
					temporalScore: 0,
					score: 0,
					rank: 0,
					refId: String,
					versions: 
					{
						String: String
					},
					createdDate: 0001-01-01,
					createdBy: String,
					modifiedDate: 0001-01-01,
					modifiedBy: String,
					deletedDate: 0001-01-01,
					deletedBy: String
				}
			],
			error: String,
			ownerId: 0,
			ownerRef: String,
			key: String,
			curated: False,
			rating: 0,
			private: False,
			score: 0,
			rank: 0,
			refId: String,
			requestId: String,
			engineId: String,
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			deletedBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}