Member Junction
    Preparing search index...

    Type Alias ComponentExample

    Type that defines an example component used to inspire the creation of a new component. By definition these examples are located in a registry and can be found via the combination of their name and namespace. The optional properties can be used at runtime to store additional information as required for generation/inference needs

    type ComponentExample = {
        code?: string;
        description?: string;
        descriptionVector?: number[];
        functionalRequirements?: string;
        functionalRequirementsVector?: number[];
        name: string;
        namespace: string;
        other?: any;
        registry?: string;
        relevance?: number;
        technicalDesign?: string;
        technicalDesignVector?: number[];
        version?: string;
    }
    Index

    Properties

    code? description? descriptionVector? functionalRequirements? functionalRequirementsVector? name namespace other? registry? relevance? technicalDesign? technicalDesignVector? version?

    Properties

    code?: string
    description?: string
    descriptionVector?: number[]

    Optional runtime embedding vector calculated for description

    functionalRequirements?: string
    functionalRequirementsVector?: number[]

    Optional runtime embedding vector calculated for functional requirements

    name: string
    namespace: string
    other?: any

    Bag to hold any number of other runtime attributes

    registry?: string
    relevance?: number

    Tracks a 0-1 number that indicates the relevance of this example to the containing ComponentSpec, can be used for ranking examples by importance/relevance

    technicalDesign?: string
    technicalDesignVector?: number[]

    Optional runtime embedding vector calculated for technical design

    version?: string

    Settings

    Member Visibility

    On This Page

    Properties