@arbidocs/client 0.3.9 → 0.3.11

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.
package/dist/index.d.cts CHANGED
@@ -3114,7 +3114,7 @@ interface components {
3114
3114
  model?: string | null;
3115
3115
  /**
3116
3116
  * Stream
3117
- * @default true
3117
+ * @default false
3118
3118
  */
3119
3119
  stream: boolean;
3120
3120
  /** Instructions */
@@ -3448,6 +3448,18 @@ interface components {
3448
3448
  */
3449
3449
  annotations?: unknown[];
3450
3450
  };
3451
+ /**
3452
+ * OutputTokensDetails
3453
+ * @description Nested output token details per OpenAI spec.
3454
+ */
3455
+ OutputTokensDetails: {
3456
+ /**
3457
+ * Reasoning Tokens
3458
+ * @description Reasoning tokens used by the model
3459
+ * @default 0
3460
+ */
3461
+ reasoning_tokens: number;
3462
+ };
3451
3463
  /** ParsedDoc */
3452
3464
  ParsedDoc: {
3453
3465
  metadata: components['schemas']['ParsedDocMetadata'];
@@ -3762,6 +3774,11 @@ interface components {
3762
3774
  * @constant
3763
3775
  */
3764
3776
  type: 'response.completed';
3777
+ /**
3778
+ * Sequence Number
3779
+ * @description Monotonic sequence number for event ordering
3780
+ */
3781
+ sequence_number: number;
3765
3782
  response: components['schemas']['ResponseCompletedPayload'];
3766
3783
  /** @description Final token budget context snapshot. */
3767
3784
  context?: components['schemas']['TokenBudgetContext'] | null;
@@ -3788,6 +3805,16 @@ interface components {
3788
3805
  * @constant
3789
3806
  */
3790
3807
  status: 'completed';
3808
+ /**
3809
+ * Created At
3810
+ * @description Unix epoch timestamp when the response was created
3811
+ */
3812
+ created_at: number;
3813
+ /**
3814
+ * Model
3815
+ * @description Model name used for the response
3816
+ */
3817
+ model: string;
3791
3818
  /**
3792
3819
  * Output
3793
3820
  * @description Final output messages with content
@@ -3798,6 +3825,40 @@ interface components {
3798
3825
  /** @description Full MessageResponse plus context_usage, suggested_query */
3799
3826
  metadata: components['schemas']['MessageMetadataPayload'];
3800
3827
  };
3828
+ /**
3829
+ * ResponseContentPartAddedEvent
3830
+ * @description OpenAI response.content_part.added: announces a new content part.
3831
+ */
3832
+ ResponseContentPartAddedEvent: {
3833
+ /**
3834
+ * Type
3835
+ * @default response.content_part.added
3836
+ * @constant
3837
+ */
3838
+ type: 'response.content_part.added';
3839
+ /**
3840
+ * Sequence Number
3841
+ * @description Monotonic sequence number for event ordering
3842
+ */
3843
+ sequence_number: number;
3844
+ /**
3845
+ * Item Id
3846
+ * @description ID of the parent output message
3847
+ */
3848
+ item_id: string;
3849
+ /**
3850
+ * Output Index
3851
+ * @default 0
3852
+ */
3853
+ output_index: number;
3854
+ /**
3855
+ * Content Index
3856
+ * @default 0
3857
+ */
3858
+ content_index: number;
3859
+ /** @description The content part skeleton (empty text) */
3860
+ part: components['schemas']['OutputTextContent'];
3861
+ };
3801
3862
  /**
3802
3863
  * ResponseCreatedEvent
3803
3864
  * @description OpenAI response.created: provides response ID and initial output structure.
@@ -3814,6 +3875,11 @@ interface components {
3814
3875
  * @constant
3815
3876
  */
3816
3877
  type: 'response.created';
3878
+ /**
3879
+ * Sequence Number
3880
+ * @description Monotonic sequence number for event ordering
3881
+ */
3882
+ sequence_number: number;
3817
3883
  response: components['schemas']['ResponseCreatedPayload'];
3818
3884
  /** @description Token budget context snapshot at stream start. */
3819
3885
  context?: components['schemas']['TokenBudgetContext'] | null;
@@ -3840,6 +3906,16 @@ interface components {
3840
3906
  * @constant
3841
3907
  */
3842
3908
  status: 'in_progress';
3909
+ /**
3910
+ * Created At
3911
+ * @description Unix epoch timestamp when the response was created
3912
+ */
3913
+ created_at: number;
3914
+ /**
3915
+ * Model
3916
+ * @description Model name used for the response
3917
+ */
3918
+ model: string;
3843
3919
  /**
3844
3920
  * Output
3845
3921
  * @description Initial output messages (content is empty)
@@ -3900,6 +3976,54 @@ interface components {
3900
3976
  /** @description Error details */
3901
3977
  error: components['schemas']['ResponseError'];
3902
3978
  };
3979
+ /**
3980
+ * ResponseOutputItemAddedEvent
3981
+ * @description OpenAI response.output_item.added: announces a new output message.
3982
+ */
3983
+ ResponseOutputItemAddedEvent: {
3984
+ /**
3985
+ * Type
3986
+ * @default response.output_item.added
3987
+ * @constant
3988
+ */
3989
+ type: 'response.output_item.added';
3990
+ /**
3991
+ * Sequence Number
3992
+ * @description Monotonic sequence number for event ordering
3993
+ */
3994
+ sequence_number: number;
3995
+ /**
3996
+ * Output Index
3997
+ * @default 0
3998
+ */
3999
+ output_index: number;
4000
+ /** @description The output message skeleton */
4001
+ item: components['schemas']['OutputMessage'];
4002
+ };
4003
+ /**
4004
+ * ResponseOutputItemDoneEvent
4005
+ * @description OpenAI response.output_item.done: completed output message with full content.
4006
+ */
4007
+ ResponseOutputItemDoneEvent: {
4008
+ /**
4009
+ * Type
4010
+ * @default response.output_item.done
4011
+ * @constant
4012
+ */
4013
+ type: 'response.output_item.done';
4014
+ /**
4015
+ * Sequence Number
4016
+ * @description Monotonic sequence number for event ordering
4017
+ */
4018
+ sequence_number: number;
4019
+ /**
4020
+ * Output Index
4021
+ * @default 0
4022
+ */
4023
+ output_index: number;
4024
+ /** @description The completed output message */
4025
+ item: components['schemas']['OutputMessage'];
4026
+ };
3903
4027
  /**
3904
4028
  * ResponseOutputTextDeltaEvent
3905
4029
  * @description OpenAI response.output_text.delta: a chunk of the assistant's answer text.
@@ -3911,8 +4035,52 @@ interface components {
3911
4035
  * @constant
3912
4036
  */
3913
4037
  type: 'response.output_text.delta';
4038
+ /**
4039
+ * Item Id
4040
+ * @description ID of the parent output message
4041
+ * @default
4042
+ */
4043
+ item_id: string;
4044
+ /**
4045
+ * Output Index
4046
+ * @default 0
4047
+ */
4048
+ output_index: number;
4049
+ /**
4050
+ * Content Index
4051
+ * @default 0
4052
+ */
4053
+ content_index: number;
3914
4054
  /** Delta */
3915
4055
  delta: string;
4056
+ /**
4057
+ * Sequence Number
4058
+ * @description Monotonic sequence number for event ordering
4059
+ * @default 0
4060
+ */
4061
+ sequence_number: number;
4062
+ };
4063
+ /**
4064
+ * ResponseOutputTextDoneEvent
4065
+ * @description OpenAI response.output_text.done: final assembled text for a content part.
4066
+ */
4067
+ ResponseOutputTextDoneEvent: {
4068
+ /**
4069
+ * Type
4070
+ * @default response.output_text.done
4071
+ * @constant
4072
+ */
4073
+ type: 'response.output_text.done';
4074
+ /**
4075
+ * Sequence Number
4076
+ * @description Monotonic sequence number for event ordering
4077
+ */
4078
+ sequence_number: number;
4079
+ /**
4080
+ * Item Id
4081
+ * @description ID of the parent output message
4082
+ */
4083
+ item_id: string;
3916
4084
  /**
3917
4085
  * Output Index
3918
4086
  * @default 0
@@ -3923,10 +4091,15 @@ interface components {
3923
4091
  * @default 0
3924
4092
  */
3925
4093
  content_index: number;
4094
+ /**
4095
+ * Text
4096
+ * @description The complete assembled text
4097
+ */
4098
+ text: string;
3926
4099
  };
3927
4100
  /**
3928
4101
  * ResponseUsage
3929
- * @description Token usage summary in a completed response.
4102
+ * @description Token usage summary in a completed response (OpenAI format).
3930
4103
  */
3931
4104
  ResponseUsage: {
3932
4105
  /**
@@ -3939,16 +4112,13 @@ interface components {
3939
4112
  * @description Output tokens generated (excluding reasoning)
3940
4113
  */
3941
4114
  output_tokens: number;
3942
- /**
3943
- * Reasoning Tokens
3944
- * @description Reasoning tokens used by the model
3945
- */
3946
- reasoning_tokens: number;
3947
4115
  /**
3948
4116
  * Total Tokens
3949
4117
  * @description Sum of input + output + reasoning tokens
3950
4118
  */
3951
4119
  total_tokens: number;
4120
+ /** @description Detailed breakdown of output tokens */
4121
+ output_tokens_details?: components['schemas']['OutputTokensDetails'];
3952
4122
  };
3953
4123
  /** RetrievalChunkTool */
3954
4124
  RetrievalChunkTool: {
@@ -4186,15 +4356,20 @@ interface components {
4186
4356
  */
4187
4357
  SSESchemas: {
4188
4358
  response_created?: components['schemas']['ResponseCreatedEvent'] | null;
4359
+ response_output_item_added?: components['schemas']['ResponseOutputItemAddedEvent'] | null;
4360
+ response_content_part_added?: components['schemas']['ResponseContentPartAddedEvent'] | null;
4189
4361
  agent_step?: components['schemas']['AgentStepEvent'] | null;
4190
4362
  user_input_request?: components['schemas']['UserInputRequestEvent'] | null;
4191
4363
  user_message?: components['schemas']['UserMessageEvent'] | null;
4192
4364
  response_output_text_delta?: components['schemas']['ResponseOutputTextDeltaEvent'] | null;
4365
+ response_output_text_done?: components['schemas']['ResponseOutputTextDoneEvent'] | null;
4366
+ response_output_item_done?: components['schemas']['ResponseOutputItemDoneEvent'] | null;
4193
4367
  response_completed?: components['schemas']['ResponseCompletedEvent'] | null;
4194
4368
  response_failed?: components['schemas']['ResponseFailedEvent'] | null;
4195
4369
  artifact?: components['schemas']['ArtifactEvent'] | null;
4196
4370
  token_budget_context?: components['schemas']['TokenBudgetContext'] | null;
4197
4371
  response_usage?: components['schemas']['ResponseUsage'] | null;
4372
+ output_tokens_details?: components['schemas']['OutputTokensDetails'] | null;
4198
4373
  context_usage?: components['schemas']['ContextUsage'] | null;
4199
4374
  message_metadata?: components['schemas']['MessageMetadataPayload'] | null;
4200
4375
  };
package/dist/index.d.ts CHANGED
@@ -3114,7 +3114,7 @@ interface components {
3114
3114
  model?: string | null;
3115
3115
  /**
3116
3116
  * Stream
3117
- * @default true
3117
+ * @default false
3118
3118
  */
3119
3119
  stream: boolean;
3120
3120
  /** Instructions */
@@ -3448,6 +3448,18 @@ interface components {
3448
3448
  */
3449
3449
  annotations?: unknown[];
3450
3450
  };
3451
+ /**
3452
+ * OutputTokensDetails
3453
+ * @description Nested output token details per OpenAI spec.
3454
+ */
3455
+ OutputTokensDetails: {
3456
+ /**
3457
+ * Reasoning Tokens
3458
+ * @description Reasoning tokens used by the model
3459
+ * @default 0
3460
+ */
3461
+ reasoning_tokens: number;
3462
+ };
3451
3463
  /** ParsedDoc */
3452
3464
  ParsedDoc: {
3453
3465
  metadata: components['schemas']['ParsedDocMetadata'];
@@ -3762,6 +3774,11 @@ interface components {
3762
3774
  * @constant
3763
3775
  */
3764
3776
  type: 'response.completed';
3777
+ /**
3778
+ * Sequence Number
3779
+ * @description Monotonic sequence number for event ordering
3780
+ */
3781
+ sequence_number: number;
3765
3782
  response: components['schemas']['ResponseCompletedPayload'];
3766
3783
  /** @description Final token budget context snapshot. */
3767
3784
  context?: components['schemas']['TokenBudgetContext'] | null;
@@ -3788,6 +3805,16 @@ interface components {
3788
3805
  * @constant
3789
3806
  */
3790
3807
  status: 'completed';
3808
+ /**
3809
+ * Created At
3810
+ * @description Unix epoch timestamp when the response was created
3811
+ */
3812
+ created_at: number;
3813
+ /**
3814
+ * Model
3815
+ * @description Model name used for the response
3816
+ */
3817
+ model: string;
3791
3818
  /**
3792
3819
  * Output
3793
3820
  * @description Final output messages with content
@@ -3798,6 +3825,40 @@ interface components {
3798
3825
  /** @description Full MessageResponse plus context_usage, suggested_query */
3799
3826
  metadata: components['schemas']['MessageMetadataPayload'];
3800
3827
  };
3828
+ /**
3829
+ * ResponseContentPartAddedEvent
3830
+ * @description OpenAI response.content_part.added: announces a new content part.
3831
+ */
3832
+ ResponseContentPartAddedEvent: {
3833
+ /**
3834
+ * Type
3835
+ * @default response.content_part.added
3836
+ * @constant
3837
+ */
3838
+ type: 'response.content_part.added';
3839
+ /**
3840
+ * Sequence Number
3841
+ * @description Monotonic sequence number for event ordering
3842
+ */
3843
+ sequence_number: number;
3844
+ /**
3845
+ * Item Id
3846
+ * @description ID of the parent output message
3847
+ */
3848
+ item_id: string;
3849
+ /**
3850
+ * Output Index
3851
+ * @default 0
3852
+ */
3853
+ output_index: number;
3854
+ /**
3855
+ * Content Index
3856
+ * @default 0
3857
+ */
3858
+ content_index: number;
3859
+ /** @description The content part skeleton (empty text) */
3860
+ part: components['schemas']['OutputTextContent'];
3861
+ };
3801
3862
  /**
3802
3863
  * ResponseCreatedEvent
3803
3864
  * @description OpenAI response.created: provides response ID and initial output structure.
@@ -3814,6 +3875,11 @@ interface components {
3814
3875
  * @constant
3815
3876
  */
3816
3877
  type: 'response.created';
3878
+ /**
3879
+ * Sequence Number
3880
+ * @description Monotonic sequence number for event ordering
3881
+ */
3882
+ sequence_number: number;
3817
3883
  response: components['schemas']['ResponseCreatedPayload'];
3818
3884
  /** @description Token budget context snapshot at stream start. */
3819
3885
  context?: components['schemas']['TokenBudgetContext'] | null;
@@ -3840,6 +3906,16 @@ interface components {
3840
3906
  * @constant
3841
3907
  */
3842
3908
  status: 'in_progress';
3909
+ /**
3910
+ * Created At
3911
+ * @description Unix epoch timestamp when the response was created
3912
+ */
3913
+ created_at: number;
3914
+ /**
3915
+ * Model
3916
+ * @description Model name used for the response
3917
+ */
3918
+ model: string;
3843
3919
  /**
3844
3920
  * Output
3845
3921
  * @description Initial output messages (content is empty)
@@ -3900,6 +3976,54 @@ interface components {
3900
3976
  /** @description Error details */
3901
3977
  error: components['schemas']['ResponseError'];
3902
3978
  };
3979
+ /**
3980
+ * ResponseOutputItemAddedEvent
3981
+ * @description OpenAI response.output_item.added: announces a new output message.
3982
+ */
3983
+ ResponseOutputItemAddedEvent: {
3984
+ /**
3985
+ * Type
3986
+ * @default response.output_item.added
3987
+ * @constant
3988
+ */
3989
+ type: 'response.output_item.added';
3990
+ /**
3991
+ * Sequence Number
3992
+ * @description Monotonic sequence number for event ordering
3993
+ */
3994
+ sequence_number: number;
3995
+ /**
3996
+ * Output Index
3997
+ * @default 0
3998
+ */
3999
+ output_index: number;
4000
+ /** @description The output message skeleton */
4001
+ item: components['schemas']['OutputMessage'];
4002
+ };
4003
+ /**
4004
+ * ResponseOutputItemDoneEvent
4005
+ * @description OpenAI response.output_item.done: completed output message with full content.
4006
+ */
4007
+ ResponseOutputItemDoneEvent: {
4008
+ /**
4009
+ * Type
4010
+ * @default response.output_item.done
4011
+ * @constant
4012
+ */
4013
+ type: 'response.output_item.done';
4014
+ /**
4015
+ * Sequence Number
4016
+ * @description Monotonic sequence number for event ordering
4017
+ */
4018
+ sequence_number: number;
4019
+ /**
4020
+ * Output Index
4021
+ * @default 0
4022
+ */
4023
+ output_index: number;
4024
+ /** @description The completed output message */
4025
+ item: components['schemas']['OutputMessage'];
4026
+ };
3903
4027
  /**
3904
4028
  * ResponseOutputTextDeltaEvent
3905
4029
  * @description OpenAI response.output_text.delta: a chunk of the assistant's answer text.
@@ -3911,8 +4035,52 @@ interface components {
3911
4035
  * @constant
3912
4036
  */
3913
4037
  type: 'response.output_text.delta';
4038
+ /**
4039
+ * Item Id
4040
+ * @description ID of the parent output message
4041
+ * @default
4042
+ */
4043
+ item_id: string;
4044
+ /**
4045
+ * Output Index
4046
+ * @default 0
4047
+ */
4048
+ output_index: number;
4049
+ /**
4050
+ * Content Index
4051
+ * @default 0
4052
+ */
4053
+ content_index: number;
3914
4054
  /** Delta */
3915
4055
  delta: string;
4056
+ /**
4057
+ * Sequence Number
4058
+ * @description Monotonic sequence number for event ordering
4059
+ * @default 0
4060
+ */
4061
+ sequence_number: number;
4062
+ };
4063
+ /**
4064
+ * ResponseOutputTextDoneEvent
4065
+ * @description OpenAI response.output_text.done: final assembled text for a content part.
4066
+ */
4067
+ ResponseOutputTextDoneEvent: {
4068
+ /**
4069
+ * Type
4070
+ * @default response.output_text.done
4071
+ * @constant
4072
+ */
4073
+ type: 'response.output_text.done';
4074
+ /**
4075
+ * Sequence Number
4076
+ * @description Monotonic sequence number for event ordering
4077
+ */
4078
+ sequence_number: number;
4079
+ /**
4080
+ * Item Id
4081
+ * @description ID of the parent output message
4082
+ */
4083
+ item_id: string;
3916
4084
  /**
3917
4085
  * Output Index
3918
4086
  * @default 0
@@ -3923,10 +4091,15 @@ interface components {
3923
4091
  * @default 0
3924
4092
  */
3925
4093
  content_index: number;
4094
+ /**
4095
+ * Text
4096
+ * @description The complete assembled text
4097
+ */
4098
+ text: string;
3926
4099
  };
3927
4100
  /**
3928
4101
  * ResponseUsage
3929
- * @description Token usage summary in a completed response.
4102
+ * @description Token usage summary in a completed response (OpenAI format).
3930
4103
  */
3931
4104
  ResponseUsage: {
3932
4105
  /**
@@ -3939,16 +4112,13 @@ interface components {
3939
4112
  * @description Output tokens generated (excluding reasoning)
3940
4113
  */
3941
4114
  output_tokens: number;
3942
- /**
3943
- * Reasoning Tokens
3944
- * @description Reasoning tokens used by the model
3945
- */
3946
- reasoning_tokens: number;
3947
4115
  /**
3948
4116
  * Total Tokens
3949
4117
  * @description Sum of input + output + reasoning tokens
3950
4118
  */
3951
4119
  total_tokens: number;
4120
+ /** @description Detailed breakdown of output tokens */
4121
+ output_tokens_details?: components['schemas']['OutputTokensDetails'];
3952
4122
  };
3953
4123
  /** RetrievalChunkTool */
3954
4124
  RetrievalChunkTool: {
@@ -4186,15 +4356,20 @@ interface components {
4186
4356
  */
4187
4357
  SSESchemas: {
4188
4358
  response_created?: components['schemas']['ResponseCreatedEvent'] | null;
4359
+ response_output_item_added?: components['schemas']['ResponseOutputItemAddedEvent'] | null;
4360
+ response_content_part_added?: components['schemas']['ResponseContentPartAddedEvent'] | null;
4189
4361
  agent_step?: components['schemas']['AgentStepEvent'] | null;
4190
4362
  user_input_request?: components['schemas']['UserInputRequestEvent'] | null;
4191
4363
  user_message?: components['schemas']['UserMessageEvent'] | null;
4192
4364
  response_output_text_delta?: components['schemas']['ResponseOutputTextDeltaEvent'] | null;
4365
+ response_output_text_done?: components['schemas']['ResponseOutputTextDoneEvent'] | null;
4366
+ response_output_item_done?: components['schemas']['ResponseOutputItemDoneEvent'] | null;
4193
4367
  response_completed?: components['schemas']['ResponseCompletedEvent'] | null;
4194
4368
  response_failed?: components['schemas']['ResponseFailedEvent'] | null;
4195
4369
  artifact?: components['schemas']['ArtifactEvent'] | null;
4196
4370
  token_budget_context?: components['schemas']['TokenBudgetContext'] | null;
4197
4371
  response_usage?: components['schemas']['ResponseUsage'] | null;
4372
+ output_tokens_details?: components['schemas']['OutputTokensDetails'] | null;
4198
4373
  context_usage?: components['schemas']['ContextUsage'] | null;
4199
4374
  message_metadata?: components['schemas']['MessageMetadataPayload'] | null;
4200
4375
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arbidocs/client",
3
- "version": "0.3.9",
3
+ "version": "0.3.11",
4
4
  "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",