Class: DatadogAPIClient::V2::AIGuardEvaluateAttributesResponse

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb

Overview

The evaluation result with the recommended action and detected threat information.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#action ⇒ Object

The recommended action for the evaluated conversation.



25
26
27
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 25

def action
  @action
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



70
71
72
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 70

def additional_properties
  @additional_properties
end

#extra_tags ⇒ Object

The span tags that tracers should add to the ai_guard span. Each item contains a backend-defined key and value, and clients should not assume a fixed set of keys. Example keys include ai_guard.evaluate_id and ai_guard.evaluation_context.



30
31
32
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 30

def extra_tags
  @extra_tags
end

#global_prob ⇒ Object

The global threat probability, between 0 and 1. Included only when computed.



33
34
35
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 33

def global_prob
  @global_prob
end

#is_blocking_enabled ⇒ Object

Whether blocking is enabled for the organization.



36
37
38
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 36

def is_blocking_enabled
  @is_blocking_enabled
end

#reason ⇒ Object

The explanation for the recommended action, for logging rather than user-facing display.



39
40
41
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 39

def reason
  @reason
end

#redaction_replacements ⇒ Object

The redacted replacements computed for the request. Included only when redaction applies.



42
43
44
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 42

def redaction_replacements
  @redaction_replacements
end

#scfw_findings ⇒ Object

The Supply Chain Firewall verdict for the version-pinned install packages found in the request. Evaluation requires Supply Chain Firewall to be enabled for the organization and the caller to have the appsec_vm_read permission. Without that permission, Supply Chain Firewall evaluation is skipped; the AI Guard evaluation request itself is not rejected. Findings are omitted when Supply Chain Firewall does not produce a result. The recommended action combines the package outcomes. Confirmation support is inferred from the evaluator profile, not from a separate confirmation-capability flag. By default, a non-empty meta.coding_agent selects the coding-agent profile, which assumes the caller can ask for confirmation and retains WARN in recommended_action. Omitting meta.coding_agent or setting it to an empty string selects the default profile, which assumes the caller cannot ask for confirmation and returns ALLOW instead of WARN in recommended_action. Package outcomes still retain WARN, and BLOCK is never changed to ALLOW by this rule.



59
60
61
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 59

def scfw_findings
  @scfw_findings
end

#sds_findings ⇒ Object

The sensitive data findings from the Sensitive Data Scanner. Included only when findings exist.



62
63
64
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 62

def sds_findings
  @sds_findings
end

#tag_probs ⇒ Object

The detection confidence for each threat tag, between 0 and 1. May be null when the evaluation does not produce per-category scores.



65
66
67
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 65

def tag_probs
  @tag_probs
end

#tags ⇒ Object

The threat tags detected in the conversation.



68
69
70
# File 'lib/datadog_api_client/v2/models/ai_guard_evaluate_attributes_response.rb', line 68

def tags
  @tags
end