apologist 1.2.1 → 1.3.1

data/lib/Apologist/chat/types/chat_completion_request_response_format.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      class ChatCompletionRequestResponseFormat < Internal::Types::Model
+        field :type, -> { Apologist::Chat::Types::ChatCompletionRequestResponseFormatType }, optional: true, nullable: false
+
+        field :json_schema, -> { Apologist::Chat::Types::ChatCompletionRequestResponseFormatJSONSchema }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/chat_completion_request_response_format_json_schema.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      # Required when type is json_schema. Supplies the JSON Schema the structured output must conform to. Structured
+      # outputs are non-streaming.
+      class ChatCompletionRequestResponseFormatJSONSchema < Internal::Types::Model
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :description, -> { String }, optional: true, nullable: false
+
+        field :schema, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+        field :strict, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/chat_completion_request_response_format_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      module ChatCompletionRequestResponseFormatType
+        extend Apologist::Internal::Types::Enum
+
+        TEXT = "text"
+        HTML = "html"
+        JSON_ = "json"
+        RAW = "raw"
+        JSON_SCHEMA = "json_schema"
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/chat_completion_request_tool_choice.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      class ChatCompletionRequestToolChoice < Internal::Types::Model
+        extend Apologist::Internal::Types::Union
+
+        member -> { Apologist::Chat::Types::ChatCompletionRequestToolChoiceZero }
+
+        member -> { Internal::Types::Hash[String, Object] }
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/chat_completion_request_tool_choice_zero.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      module ChatCompletionRequestToolChoiceZero
+        extend Apologist::Internal::Types::Enum
+
+        NONE = "none"
+        AUTO = "auto"
+        REQUIRED = "required"
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/chat_completion_request_verbosity.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      module ChatCompletionRequestVerbosity
+        extend Apologist::Internal::Types::Enum
+
+        MINIMAL = "minimal"
+        LOW = "low"
+        MEDIUM = "medium"
+        HIGH = "high"
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/list_chat_completions_request.rb

@@ -39,6 +39,12 @@ module Apologist
         field :min_timestamp, -> { String }, optional: true, nullable: false
 
         field :max_timestamp, -> { String }, optional: true, nullable: false
+
+        field :traceparent, -> { String }, optional: true, nullable: false
+
+        field :tracestate, -> { String }, optional: true, nullable: false
+
+        field :baggage, -> { String }, optional: true, nullable: false
       end
     end
   end

data/lib/Apologist/chat/types/scrub_completion_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      class ScrubCompletionRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/chat/types/scrub_completion_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Chat
+    module Types
+      class ScrubCompletionResponse < Internal::Types::Model
+        field :data, -> { Apologist::Types::CompletionRedactResponse }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/client.rb

@@ -20,7 +20,7 @@ module Apologist
       @raw_client = Apologist::Internal::Http::RawClient.new(
         base_url: base_url || Apologist::Environment::DEFAULT,
         headers: {
-          "User-Agent" => "apologist/1.2.1",
+          "User-Agent" => "apologist/1.3.1",
           "X-Fern-Language" => "Ruby",
           "x-api-key" => api_key.to_s
         },

data/lib/Apologist/ct_as/client.rb

@@ -13,7 +13,7 @@ module Apologist
       # Finds matching CTAs based on conversation context, user, session, device, or messages
       #
       # @param request_options [Hash]
-      # @param params [Apologist::Types::CtaMatchRequest]
+      # @param params [Apologist::CtAs::Types::CtaMatchRequest]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -21,9 +21,7 @@ module Apologist
       # @option request_options [Integer] :timeout_in_seconds
       #
       # @example
-      #   client.ct_as.match_ctas(request: {
-      #     key: "value"
-      #   })
+      #   client.ct_as.match_ctas
       #
       # @return [Apologist::CtAs::Types::MatchCtasResponse]
       def match_ctas(request_options: {}, **params)
@@ -32,7 +30,7 @@ module Apologist
           base_url: request_options[:base_url],
           method: "POST",
           path: "ctas/match",
-          body: Apologist::Types::CtaMatchRequest.new(params).to_h,
+          body: Apologist::CtAs::Types::CtaMatchRequest.new(params).to_h,
           request_options: request_options
         )
         begin

data/lib/Apologist/ct_as/types/cta_match_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Apologist
+  module CtAs
+    module Types
+      class CtaMatchRequest < Internal::Types::Model
+        field :conversation, -> { String }, optional: true, nullable: false
+
+        field :client, -> { String }, optional: true, nullable: false
+
+        field :device, -> { String }, optional: true, nullable: false
+
+        field :language, -> { String }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :messages, -> { Internal::Types::Array[Apologist::Types::ChatMessage] }, optional: true, nullable: false
+
+        field :session, -> { String }, optional: true, nullable: false
+
+        field :user, -> { String }, optional: true, nullable: false
+
+        field :variables, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/evaluators/types/evaluator_request_content.rb

@@ -3,12 +3,13 @@
 module Apologist
   module Evaluators
     module Types
+      # Text to evaluate, an array of strings, or chat messages.
       class EvaluatorRequestContent < Internal::Types::Model
         extend Apologist::Internal::Types::Union
 
         member -> { String }
 
-        member -> { Internal::Types::Array[Object] }
+        member -> { Internal::Types::Array[Apologist::Evaluators::Types::EvaluatorRequestContentOneItem] }
       end
     end
   end

data/lib/Apologist/evaluators/types/evaluator_request_content_one_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Evaluators
+    module Types
+      class EvaluatorRequestContentOneItem < Internal::Types::Model
+        extend Apologist::Internal::Types::Union
+
+        member -> { String }
+
+        member -> { Apologist::Types::ChatMessage }
+      end
+    end
+  end
+end

data/lib/Apologist/types/chatwoot_conversation_meta.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    class ChatwootConversationMeta < Internal::Types::Model
+      field :assignee_type, -> { String }, optional: true, nullable: false
+
+      field :sender, -> { Apologist::Types::ChatwootConversationMetaSender }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/types/chatwoot_conversation_meta_sender.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    class ChatwootConversationMetaSender < Internal::Types::Model
+      field :id, -> { Integer }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/types/completion_redact_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    # Result of scrubbing or anonymizing a chat completion's message-adjacent text. Rows and identifiers are kept.
+    class CompletionRedactResponse < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :mode, -> { Apologist::Types::CompletionRedactResponseMode }, optional: true, nullable: false
+
+      field :messages_redacted, -> { Integer }, optional: true, nullable: false
+
+      field :remaining, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/types/{chat_completion_request_reasoning_effort.rb → completion_redact_response_mode.rb}

@@ -2,12 +2,11 @@
 
 module Apologist
   module Types
-    module ChatCompletionRequestReasoningEffort
+    module CompletionRedactResponseMode
       extend Apologist::Internal::Types::Enum
 
-      LOW = "low"
-      MEDIUM = "medium"
-      HIGH = "high"
+      SCRUB = "scrub"
+      ANONYMIZE = "anonymize"
     end
   end
 end

data/lib/Apologist/types/user_flag.rb

@@ -8,6 +8,8 @@ module Apologist
 
       field :name, -> { String }, optional: true, nullable: false
 
+      field :key, -> { String }, optional: true, nullable: false
+
       field :user_id, -> { Integer }, optional: true, nullable: false
 
       field :team_id, -> { Integer }, optional: true, nullable: false

data/lib/Apologist/types/webhook_evaluation.rb

@@ -2,7 +2,7 @@
 
 module Apologist
   module Types
-    # Result of an evaluation run for CTA/guardrail events.
+    # Result of an evaluation run for CTA, guardrail, or automation events.
     class WebhookEvaluation < Internal::Types::Model
       field :score, -> { Integer }, optional: true, nullable: false
 

data/lib/Apologist/types/webhook_event_info_key.rb

@@ -8,6 +8,7 @@ module Apologist
       PROMPT_SUBMIT = "prompt_submit"
       RESPONSE_START = "response_start"
       RESPONSE_END = "response_end"
+      AUTOMATION_TRIGGER = "automation_trigger"
       AUTOMATIONS_END = "automations_end"
       RESPONSE_LIKE = "response_like"
       RESPONSE_FLAG = "response_flag"

data/lib/Apologist/types/webhook_payload.rb

@@ -3,8 +3,8 @@
 module Apologist
   module Types
     # Canonical JSON body POSTed to a configured webhook URL. `notification`, `event`, and `agent` are always present;
-    # the remaining sections appear only when relevant to the event. Treat the payload as additive and ignore
-    # unrecognised fields.
+    # `trace` is present when the event ran inside an instrumented API request. The remaining sections appear only when
+    # relevant to the event. Treat the payload as additive and ignore unrecognised fields.
     class WebhookPayload < Internal::Types::Model
       field :notification, -> { Apologist::Types::WebhookNotificationRef }, optional: false, nullable: false
 
@@ -22,9 +22,13 @@ module Apologist
 
       field :guardrail, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
 
+      field :automation, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
+
       field :evaluator, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
 
       field :evaluation, -> { Apologist::Types::WebhookEvaluation }, optional: true, nullable: false
+
+      field :trace, -> { Apologist::Types::WebhookPayloadTrace }, optional: true, nullable: false
     end
   end
 end

data/lib/Apologist/types/webhook_payload_trace.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    # OpenTelemetry context for the API request that produced this event. Present when the Agent created or continued a
+    # W3C trace.
+    class WebhookPayloadTrace < Internal::Types::Model
+      field :trace_id, -> { String }, optional: true, nullable: false
+
+      field :span_id, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apologist
-  VERSION = "1.2.1"
+  VERSION = "1.3.1"
 end

data/lib/Apologist.rb

@@ -37,10 +37,26 @@ require_relative "Apologist/internal/iterators/cursor_page_iterator"
 require_relative "Apologist/internal/iterators/offset_page_iterator"
 require_relative "Apologist/internal/url_encoded/request"
 require_relative "Apologist/chat/types/list_chat_completions_response"
+require_relative "Apologist/chat/types/chat_completion_request_logprobs"
+require_relative "Apologist/chat/types/chat_completion_request_metadata"
+require_relative "Apologist/chat/types/chat_completion_request_reasoning_effort"
+require_relative "Apologist/chat/types/chat_completion_request_verbosity"
+require_relative "Apologist/chat/types/chat_completion_request_response_format_type"
+require_relative "Apologist/chat/types/chat_completion_request_response_format_json_schema"
+require_relative "Apologist/chat/types/chat_completion_request_response_format"
+require_relative "Apologist/chat/types/chat_completion_request_tool_choice_zero"
+require_relative "Apologist/chat/types/chat_completion_request_tool_choice"
+require_relative "Apologist/types/completion_redact_response_mode"
+require_relative "Apologist/types/completion_redact_response"
+require_relative "Apologist/chat/types/scrub_completion_response"
+require_relative "Apologist/chat/types/anonymize_completion_response"
 require_relative "Apologist/chat/types/get_chat_completion_response"
 require_relative "Apologist/corpus/types/corpus_search_request_filters"
 require_relative "Apologist/corpus/types/search_corpus_response"
 require_relative "Apologist/evaluators/types/list_evaluations_response"
+require_relative "Apologist/types/chat_message_role"
+require_relative "Apologist/types/chat_message"
+require_relative "Apologist/evaluators/types/evaluator_request_content_one_item"
 require_relative "Apologist/evaluators/types/evaluator_request_content"
 require_relative "Apologist/evaluators/types/evaluator_request_reasoning_effort"
 require_relative "Apologist/evaluators/types/evaluator_request_verbosity"
@@ -60,6 +76,7 @@ require_relative "Apologist/types/user_redact_response"
 require_relative "Apologist/users/types/scrub_user_response"
 require_relative "Apologist/users/types/anonymize_user_response"
 require_relative "Apologist/benchmarks/types/list_benchmark_runs_response"
+require_relative "Apologist/benchmarks/types/benchmark_run_request_content_one_item"
 require_relative "Apologist/benchmarks/types/benchmark_run_request_content"
 require_relative "Apologist/benchmarks/types/benchmark_run_request_reasoning_effort"
 require_relative "Apologist/benchmarks/types/benchmark_run_request_verbosity"
@@ -73,6 +90,12 @@ require_relative "Apologist/conversations/types/get_conversation_response"
 require_relative "Apologist/conversations/types/pause_conversation_response"
 require_relative "Apologist/conversations/types/resume_conversation_response"
 require_relative "Apologist/channels/types/get_chatwoot_channel_status_response"
+require_relative "Apologist/channels/types/chatwoot_webhook_payload_account"
+require_relative "Apologist/channels/types/chatwoot_webhook_payload_sender"
+require_relative "Apologist/channels/types/chatwoot_webhook_payload_conversation_account"
+require_relative "Apologist/types/chatwoot_conversation_meta_sender"
+require_relative "Apologist/types/chatwoot_conversation_meta"
+require_relative "Apologist/channels/types/chatwoot_webhook_payload_conversation"
 require_relative "Apologist/channels/types/get_discord_channel_status_response"
 require_relative "Apologist/channels/types/get_line_channel_status_response"
 require_relative "Apologist/channels/types/verify_facebook_webhook_request_hub_mode"
@@ -80,22 +103,9 @@ require_relative "Apologist/channels/types/verify_whats_app_webhook_request_hub_
 require_relative "Apologist/shares/types/get_shared_messages_response"
 require_relative "Apologist/types/error"
 require_relative "Apologist/types/success_response"
-require_relative "Apologist/types/chat_message_role"
-require_relative "Apologist/types/chat_message"
-require_relative "Apologist/types/chat_completion_request_logprobs"
-require_relative "Apologist/types/chat_completion_request_metadata"
-require_relative "Apologist/types/chat_completion_request_reasoning_effort"
-require_relative "Apologist/types/chat_completion_request_verbosity"
-require_relative "Apologist/types/chat_completion_request_response_format_type"
-require_relative "Apologist/types/chat_completion_request_response_format_json_schema"
-require_relative "Apologist/types/chat_completion_request_response_format"
-require_relative "Apologist/types/chat_completion_request_tool_choice_zero"
-require_relative "Apologist/types/chat_completion_request_tool_choice"
-require_relative "Apologist/types/chat_completion_request"
 require_relative "Apologist/types/chat_completion_response_choices_item"
 require_relative "Apologist/types/chat_completion_response_usage"
 require_relative "Apologist/types/chat_completion_response"
-require_relative "Apologist/types/cta_match_request"
 require_relative "Apologist/types/webhook_notification_ref"
 require_relative "Apologist/types/webhook_event_info_key"
 require_relative "Apologist/types/webhook_event_info"
@@ -103,14 +113,18 @@ require_relative "Apologist/types/webhook_agent_ref"
 require_relative "Apologist/types/webhook_named_ref"
 require_relative "Apologist/types/webhook_cta"
 require_relative "Apologist/types/webhook_evaluation"
+require_relative "Apologist/types/webhook_payload_trace"
 require_relative "Apologist/types/webhook_payload"
 require_relative "Apologist/client"
 require_relative "Apologist/chat/client"
 require_relative "Apologist/chat/types/list_chat_completions_request"
+require_relative "Apologist/chat/types/chat_completion_request"
 require_relative "Apologist/chat/types/like_request"
 require_relative "Apologist/chat/types/flag_request"
 require_relative "Apologist/chat/types/feedback_request"
 require_relative "Apologist/chat/types/share_request"
+require_relative "Apologist/chat/types/scrub_completion_request"
+require_relative "Apologist/chat/types/anonymize_completion_request"
 require_relative "Apologist/chat/types/get_chat_completion_request"
 require_relative "Apologist/corpus/client"
 require_relative "Apologist/corpus/types/corpus_search_request"
@@ -123,6 +137,7 @@ require_relative "Apologist/evaluators/types/list_evaluations_request"
 require_relative "Apologist/evaluators/types/evaluator_request"
 require_relative "Apologist/evaluators/types/get_evaluation_request"
 require_relative "Apologist/ct_as/client"
+require_relative "Apologist/ct_as/types/cta_match_request"
 require_relative "Apologist/ct_as/types/cta_click_request"
 require_relative "Apologist/users/client"
 require_relative "Apologist/users/types/list_users_request"
@@ -143,7 +158,7 @@ require_relative "Apologist/conversations/types/pause_conversation_request"
 require_relative "Apologist/conversations/types/resume_conversation_request"
 require_relative "Apologist/channels/client"
 require_relative "Apologist/channels/types/get_chatwoot_channel_status_request"
-require_relative "Apologist/channels/types/receive_chatwoot_webhook_request"
+require_relative "Apologist/channels/types/chatwoot_webhook_payload"
 require_relative "Apologist/channels/types/get_discord_channel_status_request"
 require_relative "Apologist/channels/types/receive_discord_interaction_request"
 require_relative "Apologist/channels/types/get_line_channel_status_request"