pangea-sdk 0.0.0

data/lib/pangea/models/ai_guard/text_guard_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Models
+    module AiGuard
+      class TextGuardParams < Pangea::Internal::Type::BaseModel
+        extend Pangea::Internal::Type::RequestParameters::Converter
+        include Pangea::Internal::Type::RequestParameters
+
+        optional :text, String, nil?: true
+
+        # module Prompt
+        #   extend Pangea::Internal::Type::Union
+
+        #   variant String
+
+        #   variant -> { Pangea::Models::TextGuardParams::Prompt::StringArray }
+
+        #   StringArray = Array(String)
+        # end
+      end
+    end
+  end
+end

data/lib/pangea/models/ai_guard/text_guard_result.rb

@@ -0,0 +1,308 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Models
+    module AiGuard
+      class TextGuardResult < Pangea::Internal::Type::BaseModel
+        # @!attribute detectors
+        #   Result of the recipe analyzing and input prompt.
+        #
+        #   @return [Detectors]
+        required :detectors, -> { Detectors }
+
+        # @!attribute prompt_text
+        #   Updated prompt text, if applicable.
+        #
+        #   @return [String, nil]
+        optional :prompt_text, String, nil?: true
+
+        # @!attribute prompt_messages
+        #   Updated structured prompt, if applicable.
+        #
+        #   @return [Pangea::Internal::Type::Unknown, nil]
+        optional :prompt_messages, Hash, nil?: true
+
+        # @!attribute blocked
+        #   Whether or not the prompt triggered a block detection.
+        #
+        #   @return [Boolean, nil]
+        optional :blocked, Pangea::Internal::Type::Boolean, nil?: true
+
+        # @!attribute recipe
+        #   The Recipe that was used.
+        #
+        #   @return [String, nil]
+        optional :recipe, String, nil?: true
+
+        # @!attribute fpe_context
+        #   If an FPE redaction method returned results, this will be the
+        #   context passed to unredact.
+        #
+        #   @return [String, nil]
+        optional :fpe_context, String, nil?: true
+
+        class Detectors < Pangea::Internal::Type::BaseModel
+          # @!attribute prompt_injection
+          #
+          #   @return [PromptInjectionResult, nil]
+          optional :prompt_injection, -> { PromptInjection }, nil?: true
+
+          # @!attribute gibberish
+          #
+          #   @return [Gibberish, nil]
+          optional :gibberish, -> { Gibberish }, nil?: true
+
+          # @!attribute sentiment
+          #
+          #   @return [Sentiment, nil]
+          optional :sentiment, -> { Sentiment }, nil?: true
+
+          # @!attribute selfharm
+          #
+          #   @return [SelfHarm, nil]
+          optional :selfharm, -> { SelfHarm }, nil?: true
+
+          # @!attribute pii_entity
+          #
+          #   @return [PiiEntity, nil]
+          optional :pii_entity, -> { PiiEntity }, nil?: true
+
+          # @!attribute malicious_entity
+          #
+          #   @return [MaliciousEntity, nil]
+          optional :malicious_entity, -> { MaliciousEntity }, nil?: true
+
+          # @!attribute custom_entity
+          #
+          #   @return [CustomEntity, nil]
+          optional :custom_entity, -> { CustomEntity }, nil?: true
+
+          # @!attribute secrets_detection
+          #
+          #   @return [SecretsDetection, nil]
+          optional :secrets_detection, -> { SecretsDetection }, nil?: true
+
+          # @!attribute competitors
+          #
+          #   @return [Competitors, nil]
+          optional :competitors, -> { Competitors }, nil?: true
+
+          # @!attribute profanity_and_toxicity
+          #
+          #   @return [ProfanityAndToxicity, nil]
+          optional :profanity_and_toxicity, -> { ProfanityAndToxicity }, nil?: true
+
+          # @!attribute hardening
+          #
+          #   @return [Hardening, nil]
+          optional :hardening, -> { Hardening }, nil?: true
+
+          # @!attribute language_detection
+          #
+          #   @return [LanguageDetection, nil]
+          optional :language_detection, -> { LanguageDetection }, nil?: true
+
+          # @!attribute topic
+          #
+          #   @return [Topic, nil]
+          optional :topic, -> { Topic }, nil?: true
+
+          # @!attribute code_detection
+          #
+          #   @return [CodeDetection, nil]
+          optional :code_detection, -> { CodeDetection }, nil?: true
+
+          class PromptInjection < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Malicious Prompt was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the analyzers.
+            #
+            #   @return [Pangea::Models::AiGuard::PromptInjectionResult, nil]
+            optional :data, Pangea::Models::AiGuard::PromptInjectionResult, nil?: true
+          end
+
+          class Gibberish < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Gibberish was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the analyzers.
+            #
+            #   @return [Pangea::Models::AiGuard::ClassificationResult, nil]
+            optional :data, Pangea::Models::AiGuard::ClassificationResult, nil?: true
+          end
+
+          class Sentiment < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Negative Sentiment was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the analyzers.
+            #
+            #   @return [Pangea::Models::AiGuard::ClassificationResult, nil]
+            optional :data, Pangea::Models::AiGuard::ClassificationResult, nil?: true
+          end
+
+          class SelfHarm < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Self-harm was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the analyzers.
+            #
+            #   @return [Pangea::Models::AiGuard::ClassificationResult, nil]
+            optional :data, Pangea::Models::AiGuard::ClassificationResult, nil?: true
+          end
+
+          class PiiEntity < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the PII Entities was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected entities
+            #
+            #   @return [Pangea::Models::AiGuard::RedactEntityResult, nil]
+            optional :data, Pangea::Models::AiGuard::RedactEntityResult, nil?: true
+          end
+
+          class MaliciousEntity < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Malicious Entities was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected entities
+            #
+            #   @return [Pangea::Models::AiGuard::MaliciousEntityResult, nil]
+            optional :data, Pangea::Models::AiGuard::MaliciousEntityResult, nil?: true
+          end
+
+          class CustomEntity < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Custom Entities was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected entities
+            #
+            #   @return [Pangea::Models::AiGuard::RedactEntityResult, nil]
+            optional :data, Pangea::Models::AiGuard::RedactEntityResult, nil?: true
+          end
+
+          class SecretsDetection < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Secret Entities was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected entities
+            #
+            #   @return [Pangea::Models::AiGuard::RedactEntityResult, nil]
+            optional :data, Pangea::Models::AiGuard::RedactEntityResult, nil?: true
+          end
+
+          class Competitors < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Competitors was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected entities
+            #
+            #   @return [Pangea::Models::AiGuard::SingleEntityResult, nil]
+            optional :data, Pangea::Models::AiGuard::SingleEntityResult, nil?: true
+          end
+
+          class ProfanityAndToxicity < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Profanity and Toxic was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected entities.
+            #
+            #   @return [Pangea::Models::AiGuard::ClassificationResult, nil]
+            optional :data, Pangea::Models::AiGuard::ClassificationResult, nil?: true
+          end
+
+          class Hardening < Pangea::Internal::Type::BaseModel
+            # @!attribute data
+            #   Details about the detected languages.
+            #
+            #   @return [Pangea::Models::AiGuard::HardeningResult, nil]
+            optional :data, Pangea::Models::AiGuard::HardeningResult, nil?: true
+          end
+
+          class LanguageDetection < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Languages was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected languages.
+            #
+            #   @return [Pangea::Models::AiGuard::LanguageResult, nil]
+            optional :data, Pangea::Models::AiGuard::LanguageResult, nil?: true
+          end
+
+          class Topic < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Topics was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected topics.
+            #
+            #   @return [Pangea::Models::AiGuard::TopicResult, nil]
+            optional :data, Pangea::Models::AiGuard::TopicResult, nil?: true
+          end
+
+          class CodeDetection < Pangea::Internal::Type::BaseModel
+            # @!attribute detected
+            #   Whether or not the Code was detected.
+            #
+            #   @return [Pangea::Internal::Type::Boolean, nil]
+            optional :detected, Pangea::Internal::Type::Boolean, nil?: true
+
+            # @!attribute data
+            #   Details about the detected code.
+            #
+            #   @return [Pangea::Models::AiGuard::LanguageResult, nil]
+            optional :data, Pangea::Models::AiGuard::LanguageResult, nil?: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pangea/models/ai_guard/topic_result.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Models
+    module AiGuard
+      class TopicResult < Pangea::Internal::Type::BaseModel
+        # @!attribute action
+        #   The action taken by this Detector
+        #
+        #   @return [String, nil]
+        optional :action, String, nil?: true
+
+        # @!attribute topics
+        #   List of topics detected
+        #
+        #   @return [Pangea::Internal::Type::ArrayOf<Topic>, nil]
+        optional :topics, Pangea::Internal::Type::ArrayOf[-> { Topic }], nil?: true
+
+        class Topic < Pangea::Internal::Type::BaseModel
+          # @!attribute topic
+          #
+          #   @return [String]
+          required :topic, String
+
+          # @!attribute confidence
+          #
+          #   @return [Float]
+          required :confidence, Float
+        end
+      end
+    end
+  end
+end

data/lib/pangea/models/pangea_response.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Models
+    # @generic Result
+    class PangeaResponse
+      # A unique identifier assigned to each request made to the API. It is used
+      # to track and identify a specific request and its associated data. The
+      # `request_id` can be helpful for troubleshooting, auditing, and tracing
+      # the flow of requests within the system. It allows users to reference and
+      # retrieve information related to a particular request, such as the
+      # response, parameters, and raw data associated with that specific
+      # request.
+      #
+      # @return [String]
+      attr_accessor :request_id
+
+      # The timestamp indicates the exact moment when a request is made to the
+      # API. It represents the date and time at which the request was initiated
+      # by the client. The `request_time` is useful for tracking and analyzing
+      # the timing of requests, measuring response times, and monitoring
+      # performance metrics. It allows users to determine the duration between
+      # the request initiation and the corresponding response, aiding in the
+      # assessment of API performance and latency.
+      #
+      # @return [String]
+      attr_accessor :request_time
+
+      # Duration it takes for the API to process a request and generate a
+      # response. It represents the elapsed time from when the request is
+      # received by the API to when the corresponding response is returned to
+      # the client.
+      #
+      # @return [String]
+      attr_accessor :response_time
+
+      # It represents the status or outcome of the API request made for IP
+      # information. It indicates the current state or condition of the request
+      # and provides information on the success or failure of the request.
+      #
+      # @return [String]
+      attr_accessor :status
+
+      # Provides a concise and brief overview of the purpose or primary
+      # objective of the API endpoint. It serves as a high-level summary or
+      # description of the functionality or feature offered by the endpoint.
+      #
+      # @return [String]
+      attr_accessor :summary
+
+      # @return [generic<Result> | nil]
+      attr_accessor :result
+
+      # @api private
+      #
+      # @param response_data [Hash{Symbol=>Object}]
+      def initialize(response_data:, model:)
+        @request_id = response_data[:request_id]
+        @request_time = response_data[:request_time]
+        @response_time = response_data[:response_time]
+        @status = response_data[:status]
+        @summary = response_data[:summary]
+        @result = Pangea::Internal::Type::Converter.coerce(model, response_data[:result])
+      end
+    end
+  end
+end

data/lib/pangea/request_options.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Pangea
+  class RequestOptions < Pangea::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Pangea::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Pangea::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+  end
+end

data/lib/pangea/services/ai_guard.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Pangea
+  module Services
+    class AiGuard
+      # Creates and returns a new client for interacting with the
+      # Pangea AI Guard API.
+      #
+      # @param api_token [String, nil]
+      # @param base_url [String, nil]
+      # @param domain [String, nil]
+      def initialize(
+        api_token: nil,
+        base_url: nil,
+        domain: nil
+      )
+        if !base_url && domain
+          base_url = "https://ai-guard.#{domain}"
+        end
+
+        base_url ||= "https://ai-guard.aws.us.pangea.cloud"
+
+        @client = Pangea::Client.new(api_token: api_token, base_url: base_url)
+      end
+
+      # Analyze and redact text to avoid manipulation of the model, addition of
+      # malicious content, and other undesirable data transfers.
+      #
+      # @overload guard_text(text:, recipe:, debug:, request_options: {})
+      # @overload guard_text(messages:, recipe:, debug:, request_options: {})
+      #
+      # @param text [String, nil] Text to be scanned by AI Guard for PII,
+      #   sensitive data, malicious content, and other data types defined by the
+      #   configuration. Supports processing up to 20 KiB of text.
+      # @param messages [Array<Pangea::Models::AiGuard::TextGuardMessageParam>, nil]
+      #   Structured messages data to be scanned by AI Guard for PII, sensitive
+      #   data, malicious content, and other data types defined by the
+      #   configuration. Supports processing up to 20 KiB of JSON text using
+      #   Pangea message format.
+      # @param recipe [String, nil] Recipe key of a configuration of data types
+      #   and settings defined in the Pangea User Console. It specifies the
+      #   rules that are to be applied to the text, such as defang malicious
+      #   URLs.
+      # @param debug [Boolean, nil] Setting this value to true will provide a
+      #   detailed analysis of the text data.
+      # @param request_options [Pangea::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Pangea::Models::PangeaResponse<Pangea::Models::AiGuard::TextGuardResult>]
+      def guard_text(params)
+        parsed, options = Pangea::Models::AiGuard::TextGuardParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/text/guard",
+          body: parsed,
+          structure: Pangea::Models::PangeaResponse,
+          model: Pangea::Models::AiGuard::TextGuardResult,
+          options: options
+        )
+      end
+    end
+  end
+end

data/lib/pangea/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pangea
+  VERSION = "0.0.0"
+end

data/lib/pangea.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "date"
+require "json"
+require "net/http"
+require "time"
+
+require "connection_pool"
+
+require_relative "pangea/errors"
+require_relative "pangea/version"
+
+require_relative "pangea/internal/util"
+
+require_relative "pangea/internal/transport/pooled_net_requester"
+require_relative "pangea/internal/transport/base_client"
+
+require_relative "pangea/internal/type/converter"
+require_relative "pangea/internal/type/array_of"
+require_relative "pangea/internal/type/hash_of"
+require_relative "pangea/internal/type/base_model"
+require_relative "pangea/internal/type/boolean"
+require_relative "pangea/internal/type/request_parameters"
+require_relative "pangea/internal/type/union"
+require_relative "pangea/internal/type/unknown"
+
+require_relative "pangea/internal"
+require_relative "pangea/client"
+require_relative "pangea/request_options"
+
+require_relative "pangea/models/pangea_response"
+require_relative "pangea/models/ai_guard/classification_result"
+require_relative "pangea/models/ai_guard/hardening_result"
+require_relative "pangea/models/ai_guard/language_result"
+require_relative "pangea/models/ai_guard/malicious_entity_result"
+require_relative "pangea/models/ai_guard/prompt_injection_result"
+require_relative "pangea/models/ai_guard/redact_entity_result"
+require_relative "pangea/models/ai_guard/single_entity_result"
+require_relative "pangea/models/ai_guard/topic_result"
+require_relative "pangea/models/ai_guard/text_guard_message_param"
+require_relative "pangea/models/ai_guard/text_guard_params"
+require_relative "pangea/models/ai_guard/text_guard_result"
+
+require_relative "pangea/services/ai_guard"

data/manifest.yaml

@@ -0,0 +1,6 @@
+dependencies:
+  - cgi
+  - date
+  - json
+  - net/http
+  - time

data/rbi/lib/pangea/client.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Pangea
+  class Client < Pangea::Internal::Transport::BaseClient
+    sig { returns(String) }
+    attr_reader :api_token
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers; end
+
+    # Creates and returns a new client for interacting with the Pangea API.
+    sig do
+      params(
+        api_token: T.nilable(String),
+        base_url: T.nilable(String)
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(
+      api_token: nil,
+      base_url: nil
+    ); end
+  end
+end

data/rbi/lib/pangea/internal/internal.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    # @api private
+    module Util
+      class << self
+        # @api private
+        sig do
+          params(input: T.anything).returns(
+            T.any(T::Hash[T.anything, T.anything], T.anything)
+          )
+        end
+        def coerce_hash(input)
+        end
+
+        # @api private
+        sig do
+          params(input: T.anything).returns(
+            T.nilable(T::Hash[T.anything, T.anything])
+          )
+        end
+        def coerce_hash!(input)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/pangea/internal/transport/base_client.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module Pangea
+  module Internal
+    module Transport
+      # @api private
+      class BaseClient
+        abstract!
+
+        PLATFORM_HEADERS = T::Hash[String, String]
+
+        # @api private
+        sig { overridable.returns(T::Hash[String, String]) }
+        private def auth_headers; end
+      end
+    end
+  end
+end