apologist 1.2.1 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/.fern/replay.lock +48 -1
  4. data/README.md +1 -3
  5. data/lib/Apologist/benchmarks/client.rb +2 -1
  6. data/lib/Apologist/benchmarks/types/benchmark_run_request_content.rb +1 -1
  7. data/lib/Apologist/benchmarks/types/benchmark_run_request_content_one_item.rb +15 -0
  8. data/lib/Apologist/channels/client.rb +41 -14
  9. data/lib/Apologist/channels/types/chatwoot_webhook_payload.rb +35 -0
  10. data/lib/Apologist/channels/types/chatwoot_webhook_payload_account.rb +11 -0
  11. data/lib/Apologist/channels/types/chatwoot_webhook_payload_conversation.rb +18 -0
  12. data/lib/Apologist/channels/types/chatwoot_webhook_payload_conversation_account.rb +11 -0
  13. data/lib/Apologist/channels/types/chatwoot_webhook_payload_sender.rb +16 -0
  14. data/lib/Apologist/chat/client.rb +103 -6
  15. data/lib/Apologist/chat/types/anonymize_completion_request.rb +11 -0
  16. data/lib/Apologist/chat/types/anonymize_completion_response.rb +11 -0
  17. data/lib/Apologist/chat/types/chat_completion_request.rb +75 -0
  18. data/lib/Apologist/chat/types/chat_completion_request_logprobs.rb +15 -0
  19. data/lib/Apologist/chat/types/chat_completion_request_metadata.rb +33 -0
  20. data/lib/Apologist/chat/types/chat_completion_request_reasoning_effort.rb +15 -0
  21. data/lib/Apologist/chat/types/chat_completion_request_response_format.rb +13 -0
  22. data/lib/Apologist/chat/types/chat_completion_request_response_format_json_schema.rb +19 -0
  23. data/lib/Apologist/chat/types/chat_completion_request_response_format_type.rb +17 -0
  24. data/lib/Apologist/chat/types/chat_completion_request_tool_choice.rb +15 -0
  25. data/lib/Apologist/chat/types/chat_completion_request_tool_choice_zero.rb +15 -0
  26. data/lib/Apologist/chat/types/chat_completion_request_verbosity.rb +16 -0
  27. data/lib/Apologist/chat/types/list_chat_completions_request.rb +6 -0
  28. data/lib/Apologist/chat/types/scrub_completion_request.rb +11 -0
  29. data/lib/Apologist/chat/types/scrub_completion_response.rb +11 -0
  30. data/lib/Apologist/client.rb +1 -1
  31. data/lib/Apologist/ct_as/client.rb +3 -5
  32. data/lib/Apologist/ct_as/types/cta_match_request.rb +27 -0
  33. data/lib/Apologist/evaluators/types/evaluator_request_content.rb +2 -1
  34. data/lib/Apologist/evaluators/types/evaluator_request_content_one_item.rb +15 -0
  35. data/lib/Apologist/types/chatwoot_conversation_meta.rb +11 -0
  36. data/lib/Apologist/types/chatwoot_conversation_meta_sender.rb +11 -0
  37. data/lib/Apologist/types/completion_redact_response.rb +16 -0
  38. data/lib/Apologist/types/{chat_completion_request_reasoning_effort.rb → completion_redact_response_mode.rb} +3 -4
  39. data/lib/Apologist/types/user_flag.rb +2 -0
  40. data/lib/Apologist/types/webhook_evaluation.rb +1 -1
  41. data/lib/Apologist/types/webhook_event_info_key.rb +1 -0
  42. data/lib/Apologist/types/webhook_payload.rb +6 -2
  43. data/lib/Apologist/types/webhook_payload_trace.rb +13 -0
  44. data/lib/Apologist/version.rb +1 -1
  45. data/lib/Apologist.rb +29 -14
  46. data/reference.md +586 -24
  47. metadata +29 -14
  48. data/lib/Apologist/channels/types/receive_chatwoot_webhook_request.rb +0 -17
  49. data/lib/Apologist/types/chat_completion_request.rb +0 -11
  50. data/lib/Apologist/types/chat_completion_request_logprobs.rb +0 -13
  51. data/lib/Apologist/types/chat_completion_request_metadata.rb +0 -31
  52. data/lib/Apologist/types/chat_completion_request_response_format.rb +0 -11
  53. data/lib/Apologist/types/chat_completion_request_response_format_json_schema.rb +0 -17
  54. data/lib/Apologist/types/chat_completion_request_response_format_type.rb +0 -15
  55. data/lib/Apologist/types/chat_completion_request_tool_choice.rb +0 -13
  56. data/lib/Apologist/types/chat_completion_request_tool_choice_zero.rb +0 -13
  57. data/lib/Apologist/types/chat_completion_request_verbosity.rb +0 -14
  58. data/lib/Apologist/types/cta_match_request.rb +0 -11
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: apologist
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.1
4
+ version: 1.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Apologist
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-09-02 00:00:00.000000000 Z
11
+ date: 2026-10-21 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: The Apologist Ruby library provides convenient access to the Apologist
14
14
  API from Ruby.
@@ -33,6 +33,7 @@ files:
33
33
  - lib/Apologist/benchmarks/client.rb
34
34
  - lib/Apologist/benchmarks/types/benchmark_run_request.rb
35
35
  - lib/Apologist/benchmarks/types/benchmark_run_request_content.rb
36
+ - lib/Apologist/benchmarks/types/benchmark_run_request_content_one_item.rb
36
37
  - lib/Apologist/benchmarks/types/benchmark_run_request_reasoning_effort.rb
37
38
  - lib/Apologist/benchmarks/types/benchmark_run_request_verbosity.rb
38
39
  - lib/Apologist/benchmarks/types/get_benchmark_run_request.rb
@@ -40,6 +41,11 @@ files:
40
41
  - lib/Apologist/benchmarks/types/list_benchmark_runs_request.rb
41
42
  - lib/Apologist/benchmarks/types/list_benchmark_runs_response.rb
42
43
  - lib/Apologist/channels/client.rb
44
+ - lib/Apologist/channels/types/chatwoot_webhook_payload.rb
45
+ - lib/Apologist/channels/types/chatwoot_webhook_payload_account.rb
46
+ - lib/Apologist/channels/types/chatwoot_webhook_payload_conversation.rb
47
+ - lib/Apologist/channels/types/chatwoot_webhook_payload_conversation_account.rb
48
+ - lib/Apologist/channels/types/chatwoot_webhook_payload_sender.rb
43
49
  - lib/Apologist/channels/types/get_chatwoot_channel_status_request.rb
44
50
  - lib/Apologist/channels/types/get_chatwoot_channel_status_response.rb
45
51
  - lib/Apologist/channels/types/get_discord_channel_status_request.rb
@@ -47,7 +53,6 @@ files:
47
53
  - lib/Apologist/channels/types/get_instagram_privacy_policy_request.rb
48
54
  - lib/Apologist/channels/types/get_line_channel_status_request.rb
49
55
  - lib/Apologist/channels/types/get_line_channel_status_response.rb
50
- - lib/Apologist/channels/types/receive_chatwoot_webhook_request.rb
51
56
  - lib/Apologist/channels/types/receive_discord_interaction_request.rb
52
57
  - lib/Apologist/channels/types/receive_facebook_message_request.rb
53
58
  - lib/Apologist/channels/types/receive_line_webhook_request.rb
@@ -59,6 +64,18 @@ files:
59
64
  - lib/Apologist/channels/types/verify_whats_app_webhook_request.rb
60
65
  - lib/Apologist/channels/types/verify_whats_app_webhook_request_hub_mode.rb
61
66
  - lib/Apologist/chat/client.rb
67
+ - lib/Apologist/chat/types/anonymize_completion_request.rb
68
+ - lib/Apologist/chat/types/anonymize_completion_response.rb
69
+ - lib/Apologist/chat/types/chat_completion_request.rb
70
+ - lib/Apologist/chat/types/chat_completion_request_logprobs.rb
71
+ - lib/Apologist/chat/types/chat_completion_request_metadata.rb
72
+ - lib/Apologist/chat/types/chat_completion_request_reasoning_effort.rb
73
+ - lib/Apologist/chat/types/chat_completion_request_response_format.rb
74
+ - lib/Apologist/chat/types/chat_completion_request_response_format_json_schema.rb
75
+ - lib/Apologist/chat/types/chat_completion_request_response_format_type.rb
76
+ - lib/Apologist/chat/types/chat_completion_request_tool_choice.rb
77
+ - lib/Apologist/chat/types/chat_completion_request_tool_choice_zero.rb
78
+ - lib/Apologist/chat/types/chat_completion_request_verbosity.rb
62
79
  - lib/Apologist/chat/types/feedback_request.rb
63
80
  - lib/Apologist/chat/types/flag_request.rb
64
81
  - lib/Apologist/chat/types/get_chat_completion_request.rb
@@ -66,6 +83,8 @@ files:
66
83
  - lib/Apologist/chat/types/like_request.rb
67
84
  - lib/Apologist/chat/types/list_chat_completions_request.rb
68
85
  - lib/Apologist/chat/types/list_chat_completions_response.rb
86
+ - lib/Apologist/chat/types/scrub_completion_request.rb
87
+ - lib/Apologist/chat/types/scrub_completion_response.rb
69
88
  - lib/Apologist/chat/types/share_request.rb
70
89
  - lib/Apologist/client.rb
71
90
  - lib/Apologist/conversations/client.rb
@@ -87,6 +106,7 @@ files:
87
106
  - lib/Apologist/corpus/types/view_request.rb
88
107
  - lib/Apologist/ct_as/client.rb
89
108
  - lib/Apologist/ct_as/types/cta_click_request.rb
109
+ - lib/Apologist/ct_as/types/cta_match_request.rb
90
110
  - lib/Apologist/ct_as/types/match_ctas_response.rb
91
111
  - lib/Apologist/environment.rb
92
112
  - lib/Apologist/errors/api_error.rb
@@ -99,6 +119,7 @@ files:
99
119
  - lib/Apologist/evaluators/types/evaluate_content_response.rb
100
120
  - lib/Apologist/evaluators/types/evaluator_request.rb
101
121
  - lib/Apologist/evaluators/types/evaluator_request_content.rb
122
+ - lib/Apologist/evaluators/types/evaluator_request_content_one_item.rb
102
123
  - lib/Apologist/evaluators/types/evaluator_request_reasoning_effort.rb
103
124
  - lib/Apologist/evaluators/types/evaluator_request_verbosity.rb
104
125
  - lib/Apologist/evaluators/types/get_evaluation_request.rb
@@ -135,23 +156,16 @@ files:
135
156
  - lib/Apologist/shares/types/get_shared_messages_request.rb
136
157
  - lib/Apologist/shares/types/get_shared_messages_response.rb
137
158
  - lib/Apologist/types/agent_pause_state.rb
138
- - lib/Apologist/types/chat_completion_request.rb
139
- - lib/Apologist/types/chat_completion_request_logprobs.rb
140
- - lib/Apologist/types/chat_completion_request_metadata.rb
141
- - lib/Apologist/types/chat_completion_request_reasoning_effort.rb
142
- - lib/Apologist/types/chat_completion_request_response_format.rb
143
- - lib/Apologist/types/chat_completion_request_response_format_json_schema.rb
144
- - lib/Apologist/types/chat_completion_request_response_format_type.rb
145
- - lib/Apologist/types/chat_completion_request_tool_choice.rb
146
- - lib/Apologist/types/chat_completion_request_tool_choice_zero.rb
147
- - lib/Apologist/types/chat_completion_request_verbosity.rb
148
159
  - lib/Apologist/types/chat_completion_response.rb
149
160
  - lib/Apologist/types/chat_completion_response_choices_item.rb
150
161
  - lib/Apologist/types/chat_completion_response_usage.rb
151
162
  - lib/Apologist/types/chat_message.rb
152
163
  - lib/Apologist/types/chat_message_role.rb
164
+ - lib/Apologist/types/chatwoot_conversation_meta.rb
165
+ - lib/Apologist/types/chatwoot_conversation_meta_sender.rb
166
+ - lib/Apologist/types/completion_redact_response.rb
167
+ - lib/Apologist/types/completion_redact_response_mode.rb
153
168
  - lib/Apologist/types/conversation.rb
154
- - lib/Apologist/types/cta_match_request.rb
155
169
  - lib/Apologist/types/error.rb
156
170
  - lib/Apologist/types/success_response.rb
157
171
  - lib/Apologist/types/tag_ref.rb
@@ -167,6 +181,7 @@ files:
167
181
  - lib/Apologist/types/webhook_named_ref.rb
168
182
  - lib/Apologist/types/webhook_notification_ref.rb
169
183
  - lib/Apologist/types/webhook_payload.rb
184
+ - lib/Apologist/types/webhook_payload_trace.rb
170
185
  - lib/Apologist/users/client.rb
171
186
  - lib/Apologist/users/types/anonymize_user_request.rb
172
187
  - lib/Apologist/users/types/anonymize_user_response.rb
@@ -1,17 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Channels
5
- module Types
6
- class ReceiveChatwootWebhookRequest < Internal::Types::Model
7
- field :id, -> { String }, optional: false, nullable: false
8
-
9
- field :chatwoot_signature, -> { String }, optional: true, nullable: false, api_name: "X-Chatwoot-Signature"
10
-
11
- field :chatwoot_timestamp, -> { String }, optional: true, nullable: false, api_name: "X-Chatwoot-Timestamp"
12
-
13
- field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
14
- end
15
- end
16
- end
17
- end
@@ -1,11 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- class ChatCompletionRequest < Internal::Types::Model
6
- extend Apologist::Internal::Types::Union
7
-
8
- member -> { Object }
9
- end
10
- end
11
- end
@@ -1,13 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- class ChatCompletionRequestLogprobs < Internal::Types::Model
6
- extend Apologist::Internal::Types::Union
7
-
8
- member -> { Internal::Types::Boolean }
9
-
10
- member -> { Integer }
11
- end
12
- end
13
- end
@@ -1,31 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- class ChatCompletionRequestMetadata < Internal::Types::Model
6
- field :anonymous, -> { Internal::Types::Boolean }, optional: true, nullable: false
7
-
8
- field :conversation, -> { String }, optional: true, nullable: false
9
-
10
- field :language, -> { String }, optional: true, nullable: false
11
-
12
- field :max_memories, -> { Integer }, optional: true, nullable: false
13
-
14
- field :parent_url, -> { String }, optional: true, nullable: false
15
-
16
- field :parent_host, -> { String }, optional: true, nullable: false
17
-
18
- field :session, -> { String }, optional: true, nullable: false
19
-
20
- field :device, -> { String }, optional: true, nullable: false
21
-
22
- field :referral_code, -> { String }, optional: true, nullable: false
23
-
24
- field :shared_prompt, -> { Integer }, optional: true, nullable: false
25
-
26
- field :translation, -> { String }, optional: true, nullable: false
27
-
28
- field :variables, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
29
- end
30
- end
31
- end
@@ -1,11 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- class ChatCompletionRequestResponseFormat < Internal::Types::Model
6
- field :type, -> { Apologist::Types::ChatCompletionRequestResponseFormatType }, optional: true, nullable: false
7
-
8
- field :json_schema, -> { Apologist::Types::ChatCompletionRequestResponseFormatJSONSchema }, optional: true, nullable: false
9
- end
10
- end
11
- end
@@ -1,17 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- # Required when type is json_schema. Supplies the JSON Schema the structured output must conform to. Structured
6
- # outputs are non-streaming.
7
- class ChatCompletionRequestResponseFormatJSONSchema < Internal::Types::Model
8
- field :name, -> { String }, optional: true, nullable: false
9
-
10
- field :description, -> { String }, optional: true, nullable: false
11
-
12
- field :schema, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
13
-
14
- field :strict, -> { Internal::Types::Boolean }, optional: true, nullable: false
15
- end
16
- end
17
- end
@@ -1,15 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- module ChatCompletionRequestResponseFormatType
6
- extend Apologist::Internal::Types::Enum
7
-
8
- TEXT = "text"
9
- HTML = "html"
10
- JSON_ = "json"
11
- RAW = "raw"
12
- JSON_SCHEMA = "json_schema"
13
- end
14
- end
15
- end
@@ -1,13 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- class ChatCompletionRequestToolChoice < Internal::Types::Model
6
- extend Apologist::Internal::Types::Union
7
-
8
- member -> { Apologist::Types::ChatCompletionRequestToolChoiceZero }
9
-
10
- member -> { Internal::Types::Hash[String, Object] }
11
- end
12
- end
13
- end
@@ -1,13 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- module ChatCompletionRequestToolChoiceZero
6
- extend Apologist::Internal::Types::Enum
7
-
8
- NONE = "none"
9
- AUTO = "auto"
10
- REQUIRED = "required"
11
- end
12
- end
13
- end
@@ -1,14 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- module ChatCompletionRequestVerbosity
6
- extend Apologist::Internal::Types::Enum
7
-
8
- MINIMAL = "minimal"
9
- LOW = "low"
10
- MEDIUM = "medium"
11
- HIGH = "high"
12
- end
13
- end
14
- end
@@ -1,11 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Apologist
4
- module Types
5
- class CtaMatchRequest < Internal::Types::Model
6
- extend Apologist::Internal::Types::Union
7
-
8
- member -> { Object }
9
- end
10
- end
11
- end