package
0.7.17
Repository: https://github.com/ansys/allie-flowkit.git
Documentation: pkg.go.dev

# Functions

AddDataRequest sends a request to the add_data endpoint.
AisAcsSemanticHybridSearchs performs a semantic hybrid search in ACS Tags: - @displayName: AIS ACS Semantic Hybrid Search Parameters: - query: the query string - embeddedQuery: the embedded query - indexList: the index list - physics: the physics - topK: the number of results to be returned Returns: - output: the search results.
AisChangeAcsResponsesByFactor changes the ACS responses by a factor Tags: - @displayName: Change ACS Responses By Factor Parameters: - factors: the factors - semanticSearchOutput: the search response Returns: - changedSemanticSearchOutput: the changed search response.
AisPerformLLMFinalRequest performs a final request to LLM Tags: - @displayName: AIS Final Request Parameters: - systemTemplate: the system template for the final request - userTemplate: the user template for the final request - query: the user query - history: the conversation history - prohibitedWords: the list of prohibited words - errorList1: the list of error words - errorList2: the list of error words Returns: - stream: the stream channel.
AisPerformLLMRephraseRequest performs a rephrase request to LLM Tags: - @displayName: AIS Rephrase Request Parameters: - systemTemplate: the system template for the rephrase request - userTemplate: the user template for the rephrase request - query: the user query - history: the conversation history Returns: - rephrasedQuery: the rephrased query.
AisReturnIndexList returns the index list for AIS Tags: - @displayName: Get AIS Index List Parameters: - accessPoint: the access point Returns: - indexList: the index list.
AnsysGPTACSSemanticHybridSearchs performs a semantic hybrid search in ACS Tags: - @displayName: ACS Semantic Hybrid Search Parameters: - query: the query string - embeddedQuery: the embedded query - indexList: the index list - typeOfAsset: the type of asset - physics: the physics - product: the product - productMain: the main product - filter: the filter - filterAfterVectorSearch: the flag to define the filter order - returnedProperties: the properties to be returned - topK: the number of results to be returned from vector search - searchedEmbeddedFields: the ACS fields to be searched Returns: - output: the search results.
AnsysGPTBuildFinalQuery builds the final query for Ansys GPT Tags: - @displayName: Build Final Query Parameters: - refrasedQuery: the refrased query - context: the context Returns: - finalQuery: the final query.
AnsysGPTCheckProhibitedWords checks the user query for prohibited words Tags: - @displayName: Check Prohibited Words Parameters: - query: the user query - prohibitedWords: the list of prohibited words - errorResponseMessage: the error response message Returns: - foundProhibited: the flag indicating whether prohibited words were found - responseMessage: the response message.
AnsysGPTExtractFieldsFromQuery extracts the fields from the user query Tags: - @displayName: Extract Fields Parameters: - query: the user query - fieldValues: the field values that the user query can contain - defaultFields: the default fields that the user query can contain Returns: - fields: the extracted fields.
AnsysGPTGetSystemPrompt returns the system prompt for Ansys GPT Tags: - @displayName: Get System Prompt Parameters: - rephrasedQuery: the rephrased query Returns: - systemPrompt: the system prompt.
AnsysGPTPerformLLMRephraseRequest performs a rephrase request to LLM Tags: - @displayName: Rephrase Request Parameters: - template: the template for the rephrase request - query: the user query - history: the conversation history Returns: - rephrasedQuery: the rephrased query.
AnsysGPTPerformLLMRephraseRequestNew performs a rephrase request to LLM Tags: - @displayName: Rephrase Request New Parameters: - template: the template for the rephrase request - query: the user query - history: the conversation history Returns: - rephrasedQuery: the rephrased query.
AnsysGPTPerformLLMRequest performs a request to Ansys GPT Tags: - @displayName: LLM Request Parameters: - finalQuery: the final query - history: the conversation history - systemPrompt: the system prompt Returns: - stream: the stream channel.
AnsysGPTRemoveNoneCitationsFromSearchResponse removes none citations from search response Tags: - @displayName: Remove None Citations Parameters: - semanticSearchOutput: the search response - citations: the citations Returns: - reducedSemanticSearchOutput: the reduced search response.
AnsysGPTReorderSearchResponseAndReturnOnlyTopK reorders the search response Tags: - @displayName: Reorder Search Response Parameters: - semanticSearchOutput: the search response - topK: the number of results to be returned Returns: - reorderedSemanticSearchOutput: the reordered search response.
AnsysGPTReturnIndexList returns the index list for Ansys GPT Tags: - @displayName: List Indexes Parameters: - indexGroups: the index groups Returns: - indexList: the index list.
AppendMessageHistory appends a new message to the conversation history Tags: - @displayName: Append Message History Parameters: - newMessage: the new message - role: the role of the message - history: the conversation history Returns: - updatedHistory: the updated conversation history.
AppendStringSlices creates a new slice by appending all elements of the provided slices.
AssignStringToString assigns a string to another string Tags: - @displayName: Assign String to String Parameters: - inputString: the input string Returns: - outputString: the output string.
BuildFinalQueryForCodeLLMRequest builds the final query for a code generation request to LLM.
BuildFinalQueryForGeneralLLMRequest builds the final query for a general request to LLM.
BuildLibraryContext builds the context string for the query Tags: - @displayName: Library Context Parameters: - message: the message string - libraryContext: the library context string Returns: - messageWithContext: the message with context.
CreateCollectionRequest sends a request to the collection endpoint.
CreateDbFilter creates a filter for the KnowledgeDB.
CreateKeywordsDbFilter creates a keywords filter for the KnowledgeDB.
CreateMetadataDbFilter creates a metadata filter for the KnowledgeDB.
CreateTagsDbFilter creates a tags filter for the KnowledgeDB.
DownloadGithubFileContent downloads file content from github and returns checksum and content.
GeneralNeo4jQuery executes the given Neo4j query and returns the response.
GeneralQuery performs a general query in the KnowledgeDB.
GenerateDocumentTree generates a tree structure from the document chunks.
GetDocumentType returns the document type of a file.
GetGithubFilesToExtract gets all files from github that need to be extracted.
GetListCollections retrieves the list of collections from the KnowledgeDB.
GetLocalFileContent reads local file and returns checksum and content.
GetLocalFilesToExtract gets all files from local that need to be extracted.
LangchainSplitter splits content into chunks using langchain.
PerformBatchEmbeddingRequest performs a batch vector embedding request to LLM Tags: - @displayName: Batch Embeddings Parameters: - input: the input strings Returns: - embeddedVectors: the embedded vectors in float32 format.
PerformCodeLLMRequest performs a code generation request to LLM Tags: - @displayName: Code LLM Request Parameters: - input: the input string - history: the conversation history - isStream: the stream flag Returns: - message: the generated code - stream: the stream channel.
PerformGeneralRequest performs a general chat completion request to LLM Tags: - @displayName: General LLM Request Parameters: - input: the input string - history: the conversation history - isStream: the stream flag - systemPrompt: the system prompt Returns: - message: the generated message - stream: the stream channel.
PerformGeneralRequestSpecificModel performs a general request to LLM with a specific model Tags: - @displayName: General LLM Request (Specific Models) Parameters: - input: the user input - history: the conversation history - isStream: the flag to indicate whether the response should be streamed - systemPrompt: the system prompt - modelId: the model ID Returns: - message: the response message - stream: the stream channel.
PerformGeneralRequestWithImages performs a general request to LLM with images Tags: - @displayName: General LLM Request (with Images) Parameters: - input: the user input - history: the conversation history - isStream: the flag to indicate whether the response should be streamed - systemPrompt: the system prompt - images: the images Returns: - message: the response message - stream: the stream channel.
PerformKeywordExtractionRequest performs a keywords extraction request to LLM Tags: - @displayName: Keyword Extraction Parameters: - input: the input string - maxKeywordsSearch: the maximum number of keywords to search for Returns: - keywords: the keywords extracted from the input string as a slice of strings.
PerformSummaryRequest performs a summary request to LLM Tags: - @displayName: Summary Parameters: - input: the input string Returns: - summary: the summary extracted from the input string.
PerformVectorEmbeddingRequest performs a vector embedding request to LLM Tags: - @displayName: Embeddings Parameters: - input: the input string Returns: - embeddedVector: the embedded vector in float32 format.
RetrieveDependencies retrieves the dependencies of the specified source node.
SendAPICall sends an API call to the specified URL with the specified headers and query parameters.
SendVectorsToKnowledgeDB sends the given vector to the KnowledgeDB and returns the most relevant data.
ShortenMessageHistory shortens the conversation history to a maximum length.
SimilaritySearch performs a similarity search in the KnowledgeDB.

# Variables

No description provided by the author

# Structs

ACSRequest represents the request structure for the Azure Cognitive Search.
ACSSearchResponse represents the response structure for the Azure Cognitive Search for ansysgpt-alh & ansysgpt-scbu.
ACSSearchResponseCrtech represents the response structure for the Azure Cognitive Search for external-crtech-thermal-desktop.
ACSSearchResponse represents the response structure for the Azure Cognitive Search for lsdyna-documentation-r14.
ACSSearchResponseStruct represents the response structure for the Azure Cognitive Search for granular-ansysgpt, ansysgpt-documentation-2023r2, scade-documentation-2023r2, ansys-dot-com-marketing.
ACSSearchResponseStruct represents the response structure for the Azure Cognitive Search for ansysgpt-alh & ansysgpt-scbu.
ACSSearchResponseStructCrtech represents the response structure for the Azure Cognitive Search for external-crtech-thermal-desktop.
ACSSearchResponseStruct represents the response structure for the Azure Cognitive Search for lsdyna-documentation-r14.
ACSVectorQuery represents the vector query structure for the Azure Cognitive Search.
DataExtractionBranch represents the branch structure for the data extraction.
DataExtractionLLMInputChannelItem represents the input channel item for the data extraction llm handler workers.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author