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 .xml suffix or ?format=xml

HTTP + 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>