Pipeline: Release 4.4.0.stable91 documentation

CybercentreCanada · Feb 8, 2024 · 452662a · 452662a
1 parent 71781bf
commit 452662a
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/docs/odm/models/config.md b/docs/odm/models/config.md
@@ -712,6 +712,7 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
+| ai | [AI](/assemblyline4_docs/odm/models/config/#ai) | AI support for the UI | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [AI](/assemblyline4_docs/odm/models/config/#ai) for more details. |
 | alerting_meta | [AlertingMeta](/assemblyline4_docs/odm/models/config/#alertingmeta) | Alerting metadata fields | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [AlertingMeta](/assemblyline4_docs/odm/models/config/#alertingmeta) for more details. |
 | allow_malicious_hinting | Boolean | Allow user to tell in advance the system that a file is malicious? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | allow_raw_downloads | Boolean | Allow user to download raw files? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `True` |
@@ -748,6 +749,33 @@
 | validate_session_useragent | Boolean | Validate if the session useragent matches the useragent the session was created with | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `True` |
 
 
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+### AI
+> AI support configuration block
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| chat_url | Keyword | URL to the AI API | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `https://api.openai.com/v1/chat/completions` |
+| code | [AIQueryParams](/assemblyline4_docs/odm/models/config/#aiqueryparams) | Parameters used for code analysis | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| detailed_report | [AIQueryParams](/assemblyline4_docs/odm/models/config/#aiqueryparams) | Parameters used for detailed reports | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| executive_summary | [AIQueryParams](/assemblyline4_docs/odm/models/config/#aiqueryparams) | Parameters used for executive summaries | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| enabled | Boolean | Is AI support enabled? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| headers | Mapping [String, Keyword] | Headers used by the url_download method | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| model_name | Keyword | Name of the model to be used for the AI analysis. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `gpt-3.5-turbo` |
+| verify | Boolean | Should the SSL connection to the AI API be verified. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `True` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+#### AIQueryParams
+> Parameters used during a AI query
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| system_message | Keyword | System message used for the query. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| max_tokens | Integer | Maximum ammount of token used for the response. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| options | Mapping [String, Any] | Other kwargs options directly passed to the API. | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+
+
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ### AlertingMeta
 > Alerting Metadata

diff --git a/docs/odm/models/file.md b/docs/odm/models/file.md
@@ -7,10 +7,14 @@
 | archive_ts | Date | None | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | ascii | Keyword | Dotted ASCII representation of the first 64 bytes of the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | classification | Classification | Classification of the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| comments | List [[Comment](/assemblyline4_docs/odm/models/file/#comment)] | List of comments made on a file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 | entropy | Float | Entropy of the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | expiry_ts | Date | Expiry timestamp | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | is_section_image | Boolean | Is this an image from an Image Result Section? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| is_supplementary | Boolean | Is this a file generated by a service? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | hex | Keyword | Hex dump of the first 64 bytes of the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| labels | List [Keyword] | List of labels of the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
+| label_categories | [LabelCategories](/assemblyline4_docs/odm/models/file/#labelcategories) | Categories of label | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [LabelCategories](/assemblyline4_docs/odm/models/file/#labelcategories) for more details. |
 | md5 | MD5 | MD5 of the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | magic | Keyword | Output from libmagic related to the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | mime | Keyword | MIME type of the file as identified by libmagic | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
@@ -25,6 +29,40 @@
 | uri_info | [URIInfo](/assemblyline4_docs/odm/models/file/#uriinfo) | URI structure to speed up specialty file searching | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 
 
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+## Comment
+> Comment Model
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| cid | UUID | Comment ID | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| uname | Keyword | Username of the user who made the comment | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| date | Date | Datetime the comment was made on | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `NOW` |
+| text | Text | Text of the comment written by the author | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| reactions | List [[Reaction](/assemblyline4_docs/odm/models/file/#reaction)] | List of reactions made on a comment | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+### Reaction
+> Reaction Model
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| icon | Enum | Icon of the user who made the reaction<br>Values:<br>`"love", "party", "smile", "surprised", "thumbs_down", "thumbs_up"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| uname | Keyword | Username of the user who made the reaction | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+## LabelCategories
+> Label Categories Model
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| info | List [Keyword] | List of extra informational labels about the file | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
+| technique | List [Keyword] | List of labels related to the technique used by the file and the signatures that hits on it. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
+| attribution | List [Keyword] | List of labels related to attribution of this file (implant name, actor, campain...) | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
+
+
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ## Seen
 > File Seen Model