yandexcloud 0.321.0__py3-none-any.whl → 0.323.0__py3-none-any.whl

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.

Potentially problematic release.


This version of yandexcloud might be problematic. Click here for more details.

Files changed (105) hide show
  1. yandex/cloud/ai/assistants/v1/assistant_pb2.pyi +38 -8
  2. yandex/cloud/ai/assistants/v1/assistant_service_pb2.pyi +89 -15
  3. yandex/cloud/ai/assistants/v1/assistant_service_pb2_grpc.py +18 -9
  4. yandex/cloud/ai/assistants/v1/assistant_service_pb2_grpc.pyi +30 -6
  5. yandex/cloud/ai/assistants/v1/common_pb2.pyi +37 -6
  6. yandex/cloud/ai/assistants/v1/runs/run_pb2.pyi +55 -9
  7. yandex/cloud/ai/assistants/v1/runs/run_service_pb2.pyi +74 -11
  8. yandex/cloud/ai/assistants/v1/runs/run_service_pb2_grpc.py +18 -8
  9. yandex/cloud/ai/assistants/v1/runs/run_service_pb2_grpc.pyi +35 -5
  10. yandex/cloud/ai/assistants/v1/searchindex/common_pb2.pyi +15 -0
  11. yandex/cloud/ai/assistants/v1/searchindex/search_index_file_pb2.pyi +8 -1
  12. yandex/cloud/ai/assistants/v1/searchindex/search_index_file_service_pb2.pyi +15 -1
  13. yandex/cloud/ai/assistants/v1/searchindex/search_index_file_service_pb2_grpc.py +10 -5
  14. yandex/cloud/ai/assistants/v1/searchindex/search_index_file_service_pb2_grpc.pyi +14 -2
  15. yandex/cloud/ai/assistants/v1/searchindex/search_index_pb2.pyi +45 -9
  16. yandex/cloud/ai/assistants/v1/searchindex/search_index_service_pb2.pyi +52 -9
  17. yandex/cloud/ai/assistants/v1/searchindex/search_index_service_pb2_grpc.py +16 -8
  18. yandex/cloud/ai/assistants/v1/searchindex/search_index_service_pb2_grpc.pyi +26 -5
  19. yandex/cloud/ai/assistants/v1/threads/message_pb2.py +18 -16
  20. yandex/cloud/ai/assistants/v1/threads/message_pb2.pyi +84 -10
  21. yandex/cloud/ai/assistants/v1/threads/message_service_pb2.pyi +21 -3
  22. yandex/cloud/ai/assistants/v1/threads/message_service_pb2_grpc.py +13 -6
  23. yandex/cloud/ai/assistants/v1/threads/message_service_pb2_grpc.pyi +24 -3
  24. yandex/cloud/ai/assistants/v1/threads/thread_pb2.pyi +22 -5
  25. yandex/cloud/ai/assistants/v1/threads/thread_service_pb2.pyi +47 -7
  26. yandex/cloud/ai/assistants/v1/threads/thread_service_pb2_grpc.py +16 -8
  27. yandex/cloud/ai/assistants/v1/threads/thread_service_pb2_grpc.pyi +26 -5
  28. yandex/cloud/ai/assistants/v1/users/user_pb2.pyi +21 -5
  29. yandex/cloud/ai/assistants/v1/users/user_service_pb2.pyi +43 -6
  30. yandex/cloud/ai/assistants/v1/users/user_service_pb2_grpc.py +16 -8
  31. yandex/cloud/ai/assistants/v1/users/user_service_pb2_grpc.pyi +26 -5
  32. yandex/cloud/ai/dataset/__init__.py +0 -0
  33. yandex/cloud/ai/dataset/v1/__init__.py +0 -0
  34. yandex/cloud/ai/dataset/v1/dataset_pb2.py +35 -0
  35. yandex/cloud/ai/dataset/v1/dataset_pb2.pyi +161 -0
  36. yandex/cloud/ai/dataset/v1/dataset_pb2_grpc.py +4 -0
  37. yandex/cloud/ai/dataset/v1/dataset_pb2_grpc.pyi +17 -0
  38. yandex/cloud/ai/dataset/v1/dataset_service_pb2.py +117 -0
  39. yandex/cloud/ai/dataset/v1/dataset_service_pb2.pyi +520 -0
  40. yandex/cloud/ai/dataset/v1/dataset_service_pb2_grpc.py +378 -0
  41. yandex/cloud/ai/dataset/v1/dataset_service_pb2_grpc.pyi +237 -0
  42. yandex/cloud/ai/files/v1/file_pb2.pyi +22 -5
  43. yandex/cloud/ai/files/v1/file_service_pb2.pyi +53 -6
  44. yandex/cloud/ai/files/v1/file_service_pb2_grpc.py +18 -9
  45. yandex/cloud/ai/files/v1/file_service_pb2_grpc.pyi +30 -6
  46. yandex/cloud/ai/foundation_models/v1/text_common_pb2.py +30 -13
  47. yandex/cloud/ai/foundation_models/v1/text_common_pb2.pyi +197 -0
  48. yandex/cloud/ai/foundation_models/v1/text_generation/text_generation_service_pb2.py +14 -14
  49. yandex/cloud/ai/foundation_models/v1/text_generation/text_generation_service_pb2.pyi +9 -1
  50. yandex/cloud/apploadbalancer/v1/load_balancer_pb2.py +52 -51
  51. yandex/cloud/apploadbalancer/v1/load_balancer_pb2.pyi +11 -1
  52. yandex/cloud/apploadbalancer/v1/rate_limit_pb2.py +35 -0
  53. yandex/cloud/apploadbalancer/v1/rate_limit_pb2.pyi +62 -0
  54. yandex/cloud/apploadbalancer/v1/rate_limit_pb2_grpc.py +4 -0
  55. yandex/cloud/apploadbalancer/v1/rate_limit_pb2_grpc.pyi +17 -0
  56. yandex/cloud/apploadbalancer/v1/virtual_host_pb2.py +44 -43
  57. yandex/cloud/apploadbalancer/v1/virtual_host_pb2.pyi +25 -6
  58. yandex/cloud/apploadbalancer/v1/virtual_host_service_pb2.py +30 -29
  59. yandex/cloud/apploadbalancer/v1/virtual_host_service_pb2.pyi +17 -4
  60. yandex/cloud/compute/v1/disk_pb2.py +12 -11
  61. yandex/cloud/compute/v1/disk_pb2.pyi +9 -2
  62. yandex/cloud/compute/v1/disk_service_pb2.py +36 -34
  63. yandex/cloud/compute/v1/disk_service_pb2.pyi +5 -1
  64. yandex/cloud/compute/v1/image_pb2.py +12 -11
  65. yandex/cloud/compute/v1/image_pb2.pyi +9 -2
  66. yandex/cloud/compute/v1/instance_service_pb2.py +39 -37
  67. yandex/cloud/compute/v1/instance_service_pb2.pyi +11 -7
  68. yandex/cloud/compute/v1/kek_pb2.py +26 -0
  69. yandex/cloud/compute/v1/kek_pb2.pyi +31 -0
  70. yandex/cloud/compute/v1/kek_pb2_grpc.py +4 -0
  71. yandex/cloud/compute/v1/kek_pb2_grpc.pyi +17 -0
  72. yandex/cloud/compute/v1/snapshot_pb2.py +8 -7
  73. yandex/cloud/compute/v1/snapshot_pb2.pyi +9 -2
  74. yandex/cloud/datasphere/v1/project_pb2.py +6 -8
  75. yandex/cloud/datasphere/v1/project_pb2.pyi +1 -35
  76. yandex/cloud/datasphere/v1/project_service_pb2.py +39 -70
  77. yandex/cloud/datasphere/v1/project_service_pb2.pyi +0 -171
  78. yandex/cloud/datasphere/v1/project_service_pb2_grpc.py +0 -102
  79. yandex/cloud/datasphere/v1/project_service_pb2_grpc.pyi +0 -60
  80. yandex/cloud/datasphere/v2/jobs/jobs_pb2.py +21 -19
  81. yandex/cloud/datasphere/v2/jobs/jobs_pb2.pyi +50 -1
  82. yandex/cloud/datasphere/v2/project_pb2.py +11 -15
  83. yandex/cloud/datasphere/v2/project_pb2.pyi +1 -55
  84. yandex/cloud/datasphere/v2/project_service_pb2.py +73 -84
  85. yandex/cloud/datasphere/v2/project_service_pb2.pyi +102 -119
  86. yandex/cloud/datasphere/v2/project_service_pb2_grpc.py +34 -70
  87. yandex/cloud/datasphere/v2/project_service_pb2_grpc.pyi +20 -52
  88. yandex/cloud/datasphere/v2/resource_types_pb2.py +2 -2
  89. yandex/cloud/datasphere/v2/resource_types_pb2.pyi +0 -4
  90. yandex/cloud/k8s/v1/cluster_service_pb2.py +38 -38
  91. yandex/cloud/k8s/v1/cluster_service_pb2.pyi +8 -2
  92. yandex/cloud/mdb/kafka/v1/cluster_pb2.py +26 -24
  93. yandex/cloud/mdb/kafka/v1/cluster_pb2.pyi +32 -5
  94. yandex/cloud/mdb/kafka/v1/connector_service_pb2.py +37 -37
  95. yandex/cloud/mdb/kafka/v1/user_pb2.pyi +1 -0
  96. yandex/cloud/mdb/redis/v1/config/redis_pb2.py +16 -8
  97. yandex/cloud/mdb/redis/v1/config/redis_pb2.pyi +56 -2
  98. yandex/cloud/serverless/containers/v1/container_service_pb2.py +19 -19
  99. yandex/cloud/serverless/functions/v1/function_service_pb2.py +37 -37
  100. {yandexcloud-0.321.0.dist-info → yandexcloud-0.323.0.dist-info}/METADATA +1 -1
  101. {yandexcloud-0.321.0.dist-info → yandexcloud-0.323.0.dist-info}/RECORD +105 -87
  102. {yandexcloud-0.321.0.dist-info → yandexcloud-0.323.0.dist-info}/WHEEL +1 -1
  103. {yandexcloud-0.321.0.dist-info → yandexcloud-0.323.0.dist-info}/AUTHORS +0 -0
  104. {yandexcloud-0.321.0.dist-info → yandexcloud-0.323.0.dist-info}/LICENSE +0 -0
  105. {yandexcloud-0.321.0.dist-info → yandexcloud-0.323.0.dist-info}/top_level.txt +0 -0
@@ -25,6 +25,8 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
25
25
 
26
26
  @typing.final
27
27
  class Run(google.protobuf.message.Message):
28
+ """Represents a run of an assistant over a specific thread of messages."""
29
+
28
30
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
29
31
 
30
32
  @typing.final
@@ -54,21 +56,41 @@ class Run(google.protobuf.message.Message):
54
56
  CUSTOM_PROMPT_TRUNCATION_OPTIONS_FIELD_NUMBER: builtins.int
55
57
  CUSTOM_COMPLETION_OPTIONS_FIELD_NUMBER: builtins.int
56
58
  id: builtins.str
59
+ """Unique identifier of the run."""
57
60
  assistant_id: builtins.str
61
+ """Identifier for the assistant that is being run."""
58
62
  thread_id: builtins.str
63
+ """Identifier for the thread of messages that this run is associated with."""
59
64
  created_by: builtins.str
65
+ """Identifier of the subject who created this run."""
60
66
  @property
61
- def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
67
+ def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
68
+ """Timestamp representing when the run was created."""
69
+
62
70
  @property
63
- def labels(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]: ...
71
+ def labels(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
72
+ """Set of key-value pairs that can be used to organize and categorize the run."""
73
+
64
74
  @property
65
- def state(self) -> global___RunState: ...
75
+ def state(self) -> global___RunState:
76
+ """Current state of the run, including its status and any associated data."""
77
+
66
78
  @property
67
- def usage(self) -> global___ContentUsage: ...
79
+ def usage(self) -> global___ContentUsage:
80
+ """Information about the content usage during the run, such as the number of [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model."""
81
+
68
82
  @property
69
- def custom_prompt_truncation_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.PromptTruncationOptions: ...
83
+ def custom_prompt_truncation_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.PromptTruncationOptions:
84
+ """Configuration options for truncating the prompt when the token count exceeds a specified limit.
85
+ If specified, these options will override the assistant's prompt truncation settings for this run.
86
+ """
87
+
70
88
  @property
71
- def custom_completion_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.CompletionOptions: ...
89
+ def custom_completion_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.CompletionOptions:
90
+ """Configuration options for completion generation.
91
+ If specified, these options will override the assistant's completion settings for this run.
92
+ """
93
+
72
94
  def __init__(
73
95
  self,
74
96
  *,
@@ -90,6 +112,8 @@ global___Run = Run
90
112
 
91
113
  @typing.final
92
114
  class RunState(google.protobuf.message.Message):
115
+ """Represents the current state of a run."""
116
+
93
117
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
94
118
 
95
119
  class _RunStatus:
@@ -99,26 +123,43 @@ class RunState(google.protobuf.message.Message):
99
123
  class _RunStatusEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[RunState._RunStatus.ValueType], builtins.type):
100
124
  DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
101
125
  RUN_STATUS_UNSPECIFIED: RunState._RunStatus.ValueType # 0
126
+ """Default unspecified status."""
102
127
  PENDING: RunState._RunStatus.ValueType # 1
128
+ """Run has been created but has not started yet."""
103
129
  IN_PROGRESS: RunState._RunStatus.ValueType # 2
130
+ """Run is currently in progress."""
104
131
  FAILED: RunState._RunStatus.ValueType # 3
132
+ """Run has failed due to an error."""
105
133
  COMPLETED: RunState._RunStatus.ValueType # 4
134
+ """Run has completed successfully."""
135
+
136
+ class RunStatus(_RunStatus, metaclass=_RunStatusEnumTypeWrapper):
137
+ """Enum representing the status of a run."""
106
138
 
107
- class RunStatus(_RunStatus, metaclass=_RunStatusEnumTypeWrapper): ...
108
139
  RUN_STATUS_UNSPECIFIED: RunState.RunStatus.ValueType # 0
140
+ """Default unspecified status."""
109
141
  PENDING: RunState.RunStatus.ValueType # 1
142
+ """Run has been created but has not started yet."""
110
143
  IN_PROGRESS: RunState.RunStatus.ValueType # 2
144
+ """Run is currently in progress."""
111
145
  FAILED: RunState.RunStatus.ValueType # 3
146
+ """Run has failed due to an error."""
112
147
  COMPLETED: RunState.RunStatus.ValueType # 4
148
+ """Run has completed successfully."""
113
149
 
114
150
  STATUS_FIELD_NUMBER: builtins.int
115
151
  ERROR_FIELD_NUMBER: builtins.int
116
152
  COMPLETED_MESSAGE_FIELD_NUMBER: builtins.int
117
153
  status: global___RunState.RunStatus.ValueType
154
+ """Current status of a run."""
118
155
  @property
119
- def error(self) -> yandex.cloud.ai.common.common_pb2.Error: ...
156
+ def error(self) -> yandex.cloud.ai.common.common_pb2.Error:
157
+ """Error information if a run has failed."""
158
+
120
159
  @property
121
- def completed_message(self) -> yandex.cloud.ai.assistants.v1.threads.message_pb2.Message: ...
160
+ def completed_message(self) -> yandex.cloud.ai.assistants.v1.threads.message_pb2.Message:
161
+ """Final message generated by an assistant if a run has completed successfully."""
162
+
122
163
  def __init__(
123
164
  self,
124
165
  *,
@@ -134,14 +175,19 @@ global___RunState = RunState
134
175
 
135
176
  @typing.final
136
177
  class ContentUsage(google.protobuf.message.Message):
178
+ """Represents the content usage during a run, such as the number of [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model."""
179
+
137
180
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
138
181
 
139
182
  PROMPT_TOKENS_FIELD_NUMBER: builtins.int
140
183
  COMPLETION_TOKENS_FIELD_NUMBER: builtins.int
141
184
  TOTAL_TOKENS_FIELD_NUMBER: builtins.int
142
185
  prompt_tokens: builtins.int
186
+ """The number of tokens used in the prompt."""
143
187
  completion_tokens: builtins.int
188
+ """The number of tokens used in the completion response."""
144
189
  total_tokens: builtins.int
190
+ """The total number of tokens used (prompt + completion)."""
145
191
  def __init__(
146
192
  self,
147
193
  *,
@@ -26,6 +26,8 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
26
26
 
27
27
  @typing.final
28
28
  class CreateRunRequest(google.protobuf.message.Message):
29
+ """Request message for creating a new run."""
30
+
29
31
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
30
32
 
31
33
  @typing.final
@@ -52,16 +54,31 @@ class CreateRunRequest(google.protobuf.message.Message):
52
54
  CUSTOM_COMPLETION_OPTIONS_FIELD_NUMBER: builtins.int
53
55
  STREAM_FIELD_NUMBER: builtins.int
54
56
  assistant_id: builtins.str
57
+ """ID of the assistant for which the run is being created"""
55
58
  thread_id: builtins.str
59
+ """ID of the thread associated with the run."""
56
60
  stream: builtins.bool
61
+ """Enables streaming of intermediate events, such as partial messages."""
57
62
  @property
58
- def labels(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]: ...
63
+ def labels(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
64
+ """Set of key-value pairs to label the run."""
65
+
59
66
  @property
60
- def additional_messages(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.assistants.v1.threads.message_pb2.MessageData]: ...
67
+ def additional_messages(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.assistants.v1.threads.message_pb2.MessageData]:
68
+ """Additional messages that will be written to the thread before the run starts."""
69
+
61
70
  @property
62
- def custom_prompt_truncation_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.PromptTruncationOptions: ...
71
+ def custom_prompt_truncation_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.PromptTruncationOptions:
72
+ """Configuration options for truncating the prompt when the token count exceeds a specified limit.
73
+ If specified, these options will override the assistant's prompt truncation settings for this run.
74
+ """
75
+
63
76
  @property
64
- def custom_completion_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.CompletionOptions: ...
77
+ def custom_completion_options(self) -> yandex.cloud.ai.assistants.v1.common_pb2.CompletionOptions:
78
+ """Configuration options for completion generation.
79
+ If specified, these options will override the assistant's completion settings for this run.
80
+ """
81
+
65
82
  def __init__(
66
83
  self,
67
84
  *,
@@ -80,13 +97,18 @@ global___CreateRunRequest = CreateRunRequest
80
97
 
81
98
  @typing.final
82
99
  class ListenRunRequest(google.protobuf.message.Message):
100
+ """Request message for listing to a run events."""
101
+
83
102
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
84
103
 
85
104
  RUN_ID_FIELD_NUMBER: builtins.int
86
105
  EVENTS_START_IDX_FIELD_NUMBER: builtins.int
87
106
  run_id: builtins.str
107
+ """ID of the run to listen to."""
88
108
  @property
89
- def events_start_idx(self) -> google.protobuf.wrappers_pb2.Int64Value: ...
109
+ def events_start_idx(self) -> google.protobuf.wrappers_pb2.Int64Value:
110
+ """Starting index for events. If provided, listening will start from this event."""
111
+
90
112
  def __init__(
91
113
  self,
92
114
  *,
@@ -100,10 +122,13 @@ global___ListenRunRequest = ListenRunRequest
100
122
 
101
123
  @typing.final
102
124
  class GetRunRequest(google.protobuf.message.Message):
125
+ """Request message for retrieving a specific run by its ID."""
126
+
103
127
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
104
128
 
105
129
  RUN_ID_FIELD_NUMBER: builtins.int
106
130
  run_id: builtins.str
131
+ """ID of the run to retrieve."""
107
132
  def __init__(
108
133
  self,
109
134
  *,
@@ -115,10 +140,13 @@ global___GetRunRequest = GetRunRequest
115
140
 
116
141
  @typing.final
117
142
  class GetLastRunByThreadRequest(google.protobuf.message.Message):
143
+ """Request message for retrieving the last run associated with a specific thread."""
144
+
118
145
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
119
146
 
120
147
  THREAD_ID_FIELD_NUMBER: builtins.int
121
148
  thread_id: builtins.str
149
+ """ID of the thread for which the last run is being fetched."""
122
150
  def __init__(
123
151
  self,
124
152
  *,
@@ -130,14 +158,19 @@ global___GetLastRunByThreadRequest = GetLastRunByThreadRequest
130
158
 
131
159
  @typing.final
132
160
  class ListRunsRequest(google.protobuf.message.Message):
161
+ """Request message for listing runs."""
162
+
133
163
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
134
164
 
135
165
  FOLDER_ID_FIELD_NUMBER: builtins.int
136
166
  PAGE_SIZE_FIELD_NUMBER: builtins.int
137
167
  PAGE_TOKEN_FIELD_NUMBER: builtins.int
138
168
  folder_id: builtins.str
169
+ """Folder ID from which to list runs."""
139
170
  page_size: builtins.int
171
+ """Maximum number of threads to return per page."""
140
172
  page_token: builtins.str
173
+ """Token to retrieve the next page of results."""
141
174
  def __init__(
142
175
  self,
143
176
  *,
@@ -151,13 +184,18 @@ global___ListRunsRequest = ListRunsRequest
151
184
 
152
185
  @typing.final
153
186
  class ListRunsResponse(google.protobuf.message.Message):
187
+ """Response message for the list operation."""
188
+
154
189
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
155
190
 
156
191
  RUNS_FIELD_NUMBER: builtins.int
157
192
  NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
158
193
  next_page_token: builtins.str
194
+ """Token to retrieve the next page of results."""
159
195
  @property
160
- def runs(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]: ...
196
+ def runs(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]:
197
+ """List of runs in the specified folder."""
198
+
161
199
  def __init__(
162
200
  self,
163
201
  *,
@@ -170,12 +208,16 @@ global___ListRunsResponse = ListRunsResponse
170
208
 
171
209
  @typing.final
172
210
  class StreamCursor(google.protobuf.message.Message):
211
+ """Represents the cursor position in a stream of events."""
212
+
173
213
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
174
214
 
175
215
  CURRENT_EVENT_IDX_FIELD_NUMBER: builtins.int
176
216
  NUM_USER_EVENTS_RECEIVED_FIELD_NUMBER: builtins.int
177
217
  current_event_idx: builtins.int
218
+ """Index of the current event in the stream."""
178
219
  num_user_events_received: builtins.int
220
+ """The number of user events received so far."""
179
221
  def __init__(
180
222
  self,
181
223
  *,
@@ -188,6 +230,8 @@ global___StreamCursor = StreamCursor
188
230
 
189
231
  @typing.final
190
232
  class StreamEvent(google.protobuf.message.Message):
233
+ """Represents an event in the stream of a run."""
234
+
191
235
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
192
236
 
193
237
  class _EventType:
@@ -197,15 +241,25 @@ class StreamEvent(google.protobuf.message.Message):
197
241
  class _EventTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[StreamEvent._EventType.ValueType], builtins.type):
198
242
  DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
199
243
  EVENT_TYPE_UNSPECIFIED: StreamEvent._EventType.ValueType # 0
244
+ """Unspecified event type."""
200
245
  PARTIAL_MESSAGE: StreamEvent._EventType.ValueType # 1
246
+ """Partial message is available."""
201
247
  ERROR: StreamEvent._EventType.ValueType # 2
248
+ """Run has failed due to an error."""
202
249
  DONE: StreamEvent._EventType.ValueType # 3
250
+ """The run has completed."""
251
+
252
+ class EventType(_EventType, metaclass=_EventTypeEnumTypeWrapper):
253
+ """Enum representing events that can occur in the stream."""
203
254
 
204
- class EventType(_EventType, metaclass=_EventTypeEnumTypeWrapper): ...
205
255
  EVENT_TYPE_UNSPECIFIED: StreamEvent.EventType.ValueType # 0
256
+ """Unspecified event type."""
206
257
  PARTIAL_MESSAGE: StreamEvent.EventType.ValueType # 1
258
+ """Partial message is available."""
207
259
  ERROR: StreamEvent.EventType.ValueType # 2
260
+ """Run has failed due to an error."""
208
261
  DONE: StreamEvent.EventType.ValueType # 3
262
+ """The run has completed."""
209
263
 
210
264
  EVENT_TYPE_FIELD_NUMBER: builtins.int
211
265
  STREAM_CURSOR_FIELD_NUMBER: builtins.int
@@ -213,14 +267,23 @@ class StreamEvent(google.protobuf.message.Message):
213
267
  PARTIAL_MESSAGE_FIELD_NUMBER: builtins.int
214
268
  COMPLETED_MESSAGE_FIELD_NUMBER: builtins.int
215
269
  event_type: global___StreamEvent.EventType.ValueType
270
+ """The type of event."""
216
271
  @property
217
- def stream_cursor(self) -> global___StreamCursor: ...
272
+ def stream_cursor(self) -> global___StreamCursor:
273
+ """The current position in the stream."""
274
+
218
275
  @property
219
- def error(self) -> yandex.cloud.ai.common.common_pb2.Error: ...
276
+ def error(self) -> yandex.cloud.ai.common.common_pb2.Error:
277
+ """Error information if the run has failed."""
278
+
220
279
  @property
221
- def partial_message(self) -> yandex.cloud.ai.assistants.v1.threads.message_pb2.MessageContent: ...
280
+ def partial_message(self) -> yandex.cloud.ai.assistants.v1.threads.message_pb2.MessageContent:
281
+ """Partially generated message."""
282
+
222
283
  @property
223
- def completed_message(self) -> yandex.cloud.ai.assistants.v1.threads.message_pb2.Message: ...
284
+ def completed_message(self) -> yandex.cloud.ai.assistants.v1.threads.message_pb2.Message:
285
+ """Final message generated by an assistant if a run has completed successfully."""
286
+
224
287
  def __init__(
225
288
  self,
226
289
  *,
@@ -7,7 +7,8 @@ from yandex.cloud.ai.assistants.v1.runs import run_service_pb2 as yandex_dot_clo
7
7
 
8
8
 
9
9
  class RunServiceStub(object):
10
- """Missing associated documentation comment in .proto file."""
10
+ """RunService provides operations for managing runs.
11
+ """
11
12
 
12
13
  def __init__(self, channel):
13
14
  """Constructor.
@@ -43,34 +44,42 @@ class RunServiceStub(object):
43
44
 
44
45
 
45
46
  class RunServiceServicer(object):
46
- """Missing associated documentation comment in .proto file."""
47
+ """RunService provides operations for managing runs.
48
+ """
47
49
 
48
50
  def Create(self, request, context):
49
- """Missing associated documentation comment in .proto file."""
51
+ """Create a new run for a given assistant and thread.
52
+ """
50
53
  context.set_code(grpc.StatusCode.UNIMPLEMENTED)
51
54
  context.set_details('Method not implemented!')
52
55
  raise NotImplementedError('Method not implemented!')
53
56
 
54
57
  def Listen(self, request, context):
55
- """Missing associated documentation comment in .proto file."""
58
+ """Listen to events from a specific run.
59
+ If the run was created with `stream = false`, Listen will only respond with the final status of the run
60
+ and will not stream partial messages or intermediate events.
61
+ """
56
62
  context.set_code(grpc.StatusCode.UNIMPLEMENTED)
57
63
  context.set_details('Method not implemented!')
58
64
  raise NotImplementedError('Method not implemented!')
59
65
 
60
66
  def Get(self, request, context):
61
- """Missing associated documentation comment in .proto file."""
67
+ """Retrieve details of a specific run by its ID.
68
+ """
62
69
  context.set_code(grpc.StatusCode.UNIMPLEMENTED)
63
70
  context.set_details('Method not implemented!')
64
71
  raise NotImplementedError('Method not implemented!')
65
72
 
66
73
  def GetLastByThread(self, request, context):
67
- """Missing associated documentation comment in .proto file."""
74
+ """Retrieves the most recent run for a specific thread.
75
+ """
68
76
  context.set_code(grpc.StatusCode.UNIMPLEMENTED)
69
77
  context.set_details('Method not implemented!')
70
78
  raise NotImplementedError('Method not implemented!')
71
79
 
72
80
  def List(self, request, context):
73
- """Missing associated documentation comment in .proto file."""
81
+ """List runs in a specific folder.
82
+ """
74
83
  context.set_code(grpc.StatusCode.UNIMPLEMENTED)
75
84
  context.set_details('Method not implemented!')
76
85
  raise NotImplementedError('Method not implemented!')
@@ -111,7 +120,8 @@ def add_RunServiceServicer_to_server(servicer, server):
111
120
 
112
121
  # This class is part of an EXPERIMENTAL API.
113
122
  class RunService(object):
114
- """Missing associated documentation comment in .proto file."""
123
+ """RunService provides operations for managing runs.
124
+ """
115
125
 
116
126
  @staticmethod
117
127
  def Create(request,
@@ -19,92 +19,122 @@ class _ServicerContext(grpc.ServicerContext, grpc.aio.ServicerContext): # type:
19
19
  ...
20
20
 
21
21
  class RunServiceStub:
22
+ """RunService provides operations for managing runs."""
23
+
22
24
  def __init__(self, channel: typing.Union[grpc.Channel, grpc.aio.Channel]) -> None: ...
23
25
  Create: grpc.UnaryUnaryMultiCallable[
24
26
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.CreateRunRequest,
25
27
  yandex.cloud.ai.assistants.v1.runs.run_pb2.Run,
26
28
  ]
29
+ """Create a new run for a given assistant and thread."""
27
30
 
28
31
  Listen: grpc.UnaryStreamMultiCallable[
29
32
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListenRunRequest,
30
33
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.StreamEvent,
31
34
  ]
35
+ """Listen to events from a specific run.
36
+ If the run was created with `stream = false`, Listen will only respond with the final status of the run
37
+ and will not stream partial messages or intermediate events.
38
+ """
32
39
 
33
40
  Get: grpc.UnaryUnaryMultiCallable[
34
41
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.GetRunRequest,
35
42
  yandex.cloud.ai.assistants.v1.runs.run_pb2.Run,
36
43
  ]
44
+ """Retrieve details of a specific run by its ID."""
37
45
 
38
46
  GetLastByThread: grpc.UnaryUnaryMultiCallable[
39
47
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.GetLastRunByThreadRequest,
40
48
  yandex.cloud.ai.assistants.v1.runs.run_pb2.Run,
41
49
  ]
50
+ """Retrieves the most recent run for a specific thread."""
42
51
 
43
52
  List: grpc.UnaryUnaryMultiCallable[
44
53
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsRequest,
45
54
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsResponse,
46
55
  ]
56
+ """List runs in a specific folder."""
47
57
 
48
58
  class RunServiceAsyncStub:
59
+ """RunService provides operations for managing runs."""
60
+
49
61
  Create: grpc.aio.UnaryUnaryMultiCallable[
50
62
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.CreateRunRequest,
51
63
  yandex.cloud.ai.assistants.v1.runs.run_pb2.Run,
52
64
  ]
65
+ """Create a new run for a given assistant and thread."""
53
66
 
54
67
  Listen: grpc.aio.UnaryStreamMultiCallable[
55
68
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListenRunRequest,
56
69
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.StreamEvent,
57
70
  ]
71
+ """Listen to events from a specific run.
72
+ If the run was created with `stream = false`, Listen will only respond with the final status of the run
73
+ and will not stream partial messages or intermediate events.
74
+ """
58
75
 
59
76
  Get: grpc.aio.UnaryUnaryMultiCallable[
60
77
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.GetRunRequest,
61
78
  yandex.cloud.ai.assistants.v1.runs.run_pb2.Run,
62
79
  ]
80
+ """Retrieve details of a specific run by its ID."""
63
81
 
64
82
  GetLastByThread: grpc.aio.UnaryUnaryMultiCallable[
65
83
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.GetLastRunByThreadRequest,
66
84
  yandex.cloud.ai.assistants.v1.runs.run_pb2.Run,
67
85
  ]
86
+ """Retrieves the most recent run for a specific thread."""
68
87
 
69
88
  List: grpc.aio.UnaryUnaryMultiCallable[
70
89
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsRequest,
71
90
  yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsResponse,
72
91
  ]
92
+ """List runs in a specific folder."""
73
93
 
74
94
  class RunServiceServicer(metaclass=abc.ABCMeta):
95
+ """RunService provides operations for managing runs."""
96
+
75
97
  @abc.abstractmethod
76
98
  def Create(
77
99
  self,
78
100
  request: yandex.cloud.ai.assistants.v1.runs.run_service_pb2.CreateRunRequest,
79
101
  context: _ServicerContext,
80
- ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]]: ...
102
+ ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]]:
103
+ """Create a new run for a given assistant and thread."""
81
104
 
82
105
  @abc.abstractmethod
83
106
  def Listen(
84
107
  self,
85
108
  request: yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListenRunRequest,
86
109
  context: _ServicerContext,
87
- ) -> typing.Union[collections.abc.Iterator[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.StreamEvent], collections.abc.AsyncIterator[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.StreamEvent]]: ...
110
+ ) -> typing.Union[collections.abc.Iterator[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.StreamEvent], collections.abc.AsyncIterator[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.StreamEvent]]:
111
+ """Listen to events from a specific run.
112
+ If the run was created with `stream = false`, Listen will only respond with the final status of the run
113
+ and will not stream partial messages or intermediate events.
114
+ """
88
115
 
89
116
  @abc.abstractmethod
90
117
  def Get(
91
118
  self,
92
119
  request: yandex.cloud.ai.assistants.v1.runs.run_service_pb2.GetRunRequest,
93
120
  context: _ServicerContext,
94
- ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]]: ...
121
+ ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]]:
122
+ """Retrieve details of a specific run by its ID."""
95
123
 
96
124
  @abc.abstractmethod
97
125
  def GetLastByThread(
98
126
  self,
99
127
  request: yandex.cloud.ai.assistants.v1.runs.run_service_pb2.GetLastRunByThreadRequest,
100
128
  context: _ServicerContext,
101
- ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]]: ...
129
+ ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_pb2.Run]]:
130
+ """Retrieves the most recent run for a specific thread."""
102
131
 
103
132
  @abc.abstractmethod
104
133
  def List(
105
134
  self,
106
135
  request: yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsRequest,
107
136
  context: _ServicerContext,
108
- ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsResponse, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsResponse]]: ...
137
+ ) -> typing.Union[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsResponse, collections.abc.Awaitable[yandex.cloud.ai.assistants.v1.runs.run_service_pb2.ListRunsResponse]]:
138
+ """List runs in a specific folder."""
109
139
 
110
140
  def add_RunServiceServicer_to_server(servicer: RunServiceServicer, server: typing.Union[grpc.Server, grpc.aio.Server]) -> None: ...
@@ -12,12 +12,23 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
12
12
 
13
13
  @typing.final
14
14
  class StaticChunkingStrategy(google.protobuf.message.Message):
15
+ """Defines a chunking strategy where chunks are created with a fixed maximum chunk size and an overlap between consecutive chunks."""
16
+
15
17
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
16
18
 
17
19
  MAX_CHUNK_SIZE_TOKENS_FIELD_NUMBER: builtins.int
18
20
  CHUNK_OVERLAP_TOKENS_FIELD_NUMBER: builtins.int
19
21
  max_chunk_size_tokens: builtins.int
22
+ """The maximum number of tokens allowed in a single chunk.
23
+ Constraints: must be within the range [100, 2048].
24
+ Default value: 800
25
+ """
20
26
  chunk_overlap_tokens: builtins.int
27
+ """The number of tokens that should overlap between consecutive chunks.
28
+ This allows for some context from the previous chunk to be included in the next chunk.
29
+ Constraints: must be less than or equal to half of `max_chunk_size_tokens`.
30
+ Default value: 400
31
+ """
21
32
  def __init__(
22
33
  self,
23
34
  *,
@@ -30,6 +41,10 @@ global___StaticChunkingStrategy = StaticChunkingStrategy
30
41
 
31
42
  @typing.final
32
43
  class ChunkingStrategy(google.protobuf.message.Message):
44
+ """Defines a general strategy for chunking text into smaller segments.
45
+ Currently, only StaticChunkingStrategy is supported.
46
+ """
47
+
33
48
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
34
49
 
35
50
  STATIC_STRATEGY_FIELD_NUMBER: builtins.int
@@ -14,6 +14,8 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
14
14
 
15
15
  @typing.final
16
16
  class SearchIndexFile(google.protobuf.message.Message):
17
+ """Represents a file that has been indexed within a search index."""
18
+
17
19
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
18
20
 
19
21
  ID_FIELD_NUMBER: builtins.int
@@ -22,10 +24,15 @@ class SearchIndexFile(google.protobuf.message.Message):
22
24
  CREATED_AT_FIELD_NUMBER: builtins.int
23
25
  CHUNKING_STRATEGY_FIELD_NUMBER: builtins.int
24
26
  id: builtins.str
27
+ """Unique identifier of the file that was used for indexing."""
25
28
  search_index_id: builtins.str
29
+ """ID of the search index that contains this file."""
26
30
  created_by: builtins.str
31
+ """Identifier of the subject who created the file in the search index."""
27
32
  @property
28
- def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
33
+ def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
34
+ """Timestamp representing when the file was created."""
35
+
29
36
  @property
30
37
  def chunking_strategy(self) -> yandex.cloud.ai.assistants.v1.searchindex.common_pb2.ChunkingStrategy: ...
31
38
  def __init__(
@@ -15,12 +15,16 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
15
15
 
16
16
  @typing.final
17
17
  class GetSearchIndexFileRequest(google.protobuf.message.Message):
18
+ """Request message for retrieving a file from a search index."""
19
+
18
20
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
19
21
 
20
22
  FILE_ID_FIELD_NUMBER: builtins.int
21
23
  SEARCH_INDEX_ID_FIELD_NUMBER: builtins.int
22
24
  file_id: builtins.str
25
+ """ID of the file to retrieve."""
23
26
  search_index_id: builtins.str
27
+ """ID of the search index that contains the file."""
24
28
  def __init__(
25
29
  self,
26
30
  *,
@@ -33,14 +37,19 @@ global___GetSearchIndexFileRequest = GetSearchIndexFileRequest
33
37
 
34
38
  @typing.final
35
39
  class ListSearchIndexFilesRequest(google.protobuf.message.Message):
40
+ """Request message for listing files in a specific search index."""
41
+
36
42
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
37
43
 
38
44
  SEARCH_INDEX_ID_FIELD_NUMBER: builtins.int
39
45
  PAGE_SIZE_FIELD_NUMBER: builtins.int
40
46
  PAGE_TOKEN_FIELD_NUMBER: builtins.int
41
47
  search_index_id: builtins.str
48
+ """ID of the search index whose files will be listed."""
42
49
  page_size: builtins.int
50
+ """Maximum number of files to return per page."""
43
51
  page_token: builtins.str
52
+ """Token to retrieve the next page of results."""
44
53
  def __init__(
45
54
  self,
46
55
  *,
@@ -54,13 +63,18 @@ global___ListSearchIndexFilesRequest = ListSearchIndexFilesRequest
54
63
 
55
64
  @typing.final
56
65
  class ListSearchIndexFilesResponse(google.protobuf.message.Message):
66
+ """Response message for the list operation."""
67
+
57
68
  DESCRIPTOR: google.protobuf.descriptor.Descriptor
58
69
 
59
70
  FILES_FIELD_NUMBER: builtins.int
60
71
  NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
61
72
  next_page_token: builtins.str
73
+ """Token to retrieve the next page of results."""
62
74
  @property
63
- def files(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.assistants.v1.searchindex.search_index_file_pb2.SearchIndexFile]: ...
75
+ def files(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.assistants.v1.searchindex.search_index_file_pb2.SearchIndexFile]:
76
+ """List of files in the specified search index."""
77
+
64
78
  def __init__(
65
79
  self,
66
80
  *,