Esempi di azioni personalizzate che utilizzano Valiassistant

Ecco alcuni script di esempio che possono essere implementati insieme alle Azioni personalizzate. Quando è indicata l’AI, lo script utilizza un prompt personalizzato che viene inviato insieme alle informazioni provenienti da Requirements, Blocks o Valis all’AI, che analizza i dati, tiene conto del prompt personalizzato e invia una risposta a Requirements & Systems Portal, che può quindi essere riscritta nell’oggetto in Requirements & Systems Portal. Sentiti libero di adattare questi script di esempio alle tue esigenze e ai tuoi casi d’uso.

Affinché questi script funzionino in Requirements & Systems Portal, devi fornire il tuo URL API nella parte di configurazione dello script all’inizio. Vedi qui come ottenere questo URL API.

Suggerimento AI per il titolo

Questo script usa l’AI per proporre un titolo breve ma preciso per i tuoi singoli requisiti.

AI_Title_Suggestion.txt

Il prompt personalizzato utilizzato è:

custom_prompt = "Based on the Text provide a short Title for this Requirement in the context of System Engineering. Do not include any numbers or Units in the title. Only return the title and no other text."

che viene inviato insieme al testo del requisito all’AI.

Suggerimento AI per il tipo di requisito

Questo script usa l’AI per categorizzare i tuoi requisiti in tipi specifici, come “Functional”, “Performance” o “System”, in base al testo del requisito. Vengono presi in considerazione tutti i tipi definiti nelle impostazioni di Requirements & System Portal.

AI_Type_Suggestion.txt

Il prompt personalizzato utilizzato è:

custom_prompt = "Respond only with the type. Take into consideration the following types: {types_string}. Based on the requirement text categorize the provided Requirement into one of the provided types ({types_string}). Return only the type in the form of 'type'."

Controllo qualità AI dei requisiti

Questo script verifica la qualità del testo del tuo requisito rispetto agli standard INCOSE di settore e fornisce una risposta quantitativa e qualitativa sotto forma di tag di qualità e suggerimento di miglioramento.

AI_Quality_Check.txt

Il prompt personalizzato utilizzato include le regole INCOSE più rilevanti:

custom_prompt = """
        Consider the following INCOSE Standards for writing Requirements:
        R1 - Use a structured, complete sentence: subject, verb, object. 
        R2 - Use the active voice in the main sentence structure of the need or requirement statement with the responsible entity clearly identified as the subject of the sentence. 
        R3 - Ensure the subject and verb of the need or requirement statement are appropriate to the entity to which the need or requirement refers. 
        R5 - Use definite article “the” rather than the indefinite article “a”.
        R6 - Use appropriate units when stating quantities. All numbers should have units of measure explicitly stated.
        R7 - Avoid the use of vague terms such as “some”, “any”, “allowable”, “several”, “many”, “a lot of”, “a few”, “almost always”, “very nearly”, “nearly”, “about”, “close to”, “almost”, and “approximate”. 
        R8 - Avoid escape clauses such as “so far as is possible”, “as little as possible”, “where possible”, “as much as possible”, “if it should prove necessary”, “if necessary”, “to the extent necessary”, “as appropriate”, “as required”, “to the extent practical”, and “if practicable”. 
        R9- Avoid open-ended clauses such as “including but not limited to”, “etc.” and “and so on”. 
        R10 - Avoid superfluous infinitives such as “be designed to”, “be able to”, “be capable of”.  
        R12, 13, 14 - Use correct grammar, spelling, punctuation.
        R15 - Use a defined convention to express logical expressions such as “[X AND Y]”, “[X OR Y]”, [X XOR Y]”, “NOT[X OR Y]”.
        R16 - Avoid the use of “not” 
        R17 - Avoid the use of the oblique ("/") symbol except in units, i.e. km/hr
        R18 - Write a single sentence that contains a single thought conditioned and qualified by relevant sub-clauses.
        R19 - Avoid combinators that join clauses, such as “and”, “or”, ”then”, ”unless”, ”but”, ”as well as”, ”but also”, ”however”, ”whether”, ”meanwhile”, ”whereas”, ”on the other hand”, or ”otherwise”. 
        R20 - Avoid phrases that indicate the purpose of the need or requirement. 
        R21 - Avoid parentheses and brackets containing subordinate text.
        R22 - Enumerate sets explicitly instead of using a group noun to name the set. 
        R24 - Avoid the use of pronouns and indefinite pronouns.
        R26 - Avoid using unachievable absolutes such as 100'%' reliability, 100'%' availability, all, every, always, never, etc.
        R28 - Express the propositional nature of a condition explicitly for a single action instead of giving lists of actions for a specific condition.
        R29 - Classify the needs and requirements according to the aspects of the problem or system it addresses. 
        R31 - When defining design inputs avoid stating a solution unless there is rationale for constraining the design. Focus on the problem “what” rather than the solution “how”. 
        R32 - Use “each” instead of “all”, “any" or “both” when universal quantification is intended. 
        R33 - Define quantities with a range of values appropriate to the entity to which they apply and to which the entity will be verified or validated against.
        R34 - Provide specific measurable performance targets appropriate to the entity to which the need or requirement is stated and against which the entity will be verified to meet.
        R35 - Define temporal dependencies explicitly instead of using indefinite temporal keywords such as “eventually”, “until”, “before”, “after”, “as”, “once”, “earliest”, “latest”, “instantaneous”, “simultaneous”, “at last”.
        R38 - Avoid the use of abbreviations.
        In base a questi standard INCOSE per i requisiti, restituiscimi SOLO un dizionario con quality_score_of_the_requirement_text da 0 a 100 e un corrispondente comment_for_improvement nella forma:
        {'Score': quality_score_of_the_requirement_text, 'Comment': comment_for_improvement}.
        """

Report AI delle incoerenze nel modulo Analysis

Questo script esegue la funzionalità “Find Inconsistencies” di ValiAssistant e produce un report nel modulo Analysis, che può poi essere esportato o condiviso.

AI_Inconsistency_Report.txt

Report di analisi dell’impatto nel modulo Analysis

Questo script esegue un’analisi del requisito selezionato per verificare quali altri requisiti, blocchi e test run potrebbero essere influenzati da una modifica nel suo campo di testo. Lo script prepara un report nel modulo Analysis che può poi essere esportato o condiviso.

Basic_Impact_Analysis.txt

Questo script di analisi dell’impatto non utilizza alcuna AI, ma può essere esteso per includere una valutazione AI della gravità dell’impatto su ciascuno degli oggetti correlati.

AI-LocalizedLocalizzato tramite A
Se trovi un problema, seleziona il testo/l’immagine e premi Ctrl + Invio per inviarci il tuo feedback.
Disponibilità delle funzionalità

Le funzionalità disponibili dipendono dalla soluzione Altium in uso – Altium Develop, un’edizione di Altium Agile (Agile Teams o Agile Enterprise), oppure Altium Designer (con licenza attiva).

Se non vedi nel tuo software una funzionalità descritta,  contatta il team vendite di Altium per saperne di più.

Contenuto