Documentation
¶
Index ¶
- func CreateReturnList(returnString string) (returnElementList []string, err error)
- func ProcessElementName(fullName string, dependencies []string) (namePseudocode string, nameFormatted string, err error)
- func RemoveEmptyLines(input string) string
- func SplitByCapitalLetters(s string) string
- type AssemblyMember
- type CodeGenerationPseudocodeResponse
- type GraphDatabaseElement
- type VectorDatabaseElement
- type VectorDatabaseExample
- type VectorDatabaseUserGuideSection
- type XMLAssembly
- type XMLObjectDefinitionDocument
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateReturnList ¶
CreateReturnList creates a list of return elements from a string
Parameters:
- returnString: the string to create the list from
Returns:
- the list of return elements
- an error if the string is empty
func ProcessElementName ¶
func ProcessElementName(fullName string, dependencies []string) (namePseudocode string, nameFormatted string, err error)
ProcessElementName processes an element name
Parameters:
- fullName: the full name of the element
- dependencies: the dependencies of the element
Returns:
- the pseudocode name of the element
- the formatted name of the element
- an error if the name is empty
func RemoveEmptyLines ¶
RemoveEmptyLines removes empty lines from a string
Parameters:
- input: the string to remove empty lines from
Returns:
- the string with empty lines removed
func SplitByCapitalLetters ¶
SplitByCapitalLetters splits a string by capital letters
Parameters:
- s: the string to split
Returns:
- the string with spaces inserted before capital letters
Types ¶
type AssemblyMember ¶
type AssemblyMember struct {
Name string `xml:"name,attr" json:"name"`
Summary string `xml:"summary" json:"summary"`
ReturnType string `xml:"returnType" json:"return_type"`
Returns string `xml:"returns,omitempty" json:"returns"`
Params []sharedtypes.XMLMemberParam `xml:"param" json:"parameters"` // Handles multiple <param> elements
Example sharedtypes.XMLMemberExample `xml:"example,omitempty" json:"example"` // Optional <example> element
Remarks string `xml:"remarks,omitempty" json:"remarks"` // Optional <remarks> element
EnumValues string `xml:"enumValues,omitempty" json:"enum_values"`
VectorDBMetadata any `xml:"vectorDBMetadata,omitempty" json:"vector_db_metadata"` // Optional <vectorDBMetadata> element
GraphDBMetadata any `xml:"graphDBMetadata,omitempty" json:"graph_db_metadata"` // Optional <graphDBMetadata> element
}
type GraphDatabaseElement ¶
type GraphDatabaseElement struct {
Guid uuid.UUID `json:"guid"`
Type string `json:"type"`
NamePseudocode string `json:"name_pseudocode"`
Description string `json:"description"`
Summary string `json:"summary"`
Examples string `json:"examples"`
Parameters []sharedtypes.XMLMemberParam `json:"parameters"`
Dependencies []string `json:"dependencies"`
ReturnType string `json:"returnType"`
Remarks string `json:"remarks"`
}
type VectorDatabaseElement ¶
type VectorDatabaseElement struct {
Guid uuid.UUID `json:"guid"`
DenseVector []float32 `json:"dense_vector"`
SparseVector map[uint]float32 `json:"sparse_vector"`
Type string `json:"type"`
Name string `json:"name"`
NamePseudocode string `json:"name_pseudocode"`
NameFormatted string `json:"name_formatted"`
ParentClass string `json:"parent_class"`
}
type VectorDatabaseExample ¶
type VectorDatabaseExample struct {
Guid uuid.UUID `json:"guid"`
DenseVector []float32 `json:"dense_vector"`
SparseVector map[uint]float32 `json:"sparse_vector"`
DocumentName string `json:"document_name"`
Dependencies []string `json:"dependencies"`
DependencyEquivalences map[string]string `json:"dependency_equivalences"`
Text string `json:"text"`
PreviousChunk *uuid.UUID `json:"previous_chunk"`
NextChunk *uuid.UUID `json:"next_chunk"`
}
type VectorDatabaseUserGuideSection ¶
type VectorDatabaseUserGuideSection struct {
Guid uuid.UUID `json:"guid"`
SectionName string `json:"section_name"`
DocumentName string `json:"document_name"`
Title string
ParentSectionName string `json:"parent_section_name"`
Text string `json:"text"`
Level int `json:"level"`
PreviousChunk *uuid.UUID `json:"previous_chunk"`
NextChunk *uuid.UUID `json:"next_chunk"`
DenseVector []float32 `json:"dense_vector"`
SparseVector map[uint]float32 `json:"sparse_vector"`
}
type XMLAssembly ¶
type XMLAssembly struct {
Name string `xml:"name"`
}
type XMLObjectDefinitionDocument ¶
type XMLObjectDefinitionDocument struct {
XMLName xml.Name `xml:"doc"`
Assembly XMLAssembly `xml:"assembly"`
Members []AssemblyMember `xml:"members>member"`
}
Structs representing the XML structure
Click to show internal directories.
Click to hide internal directories.