pulumi-oci 2.17.0__py3-none-any.whl → 2.17.0a1731653778__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.
Files changed (38) hide show
  1. pulumi_oci/__init__.py +0 -40
  2. pulumi_oci/core/_inputs.py +3 -3
  3. pulumi_oci/core/compute_capacity_reservation.py +7 -7
  4. pulumi_oci/core/get_boot_volume.py +1 -1
  5. pulumi_oci/core/get_volume.py +1 -1
  6. pulumi_oci/core/instance_pool.py +7 -7
  7. pulumi_oci/core/outputs.py +46 -46
  8. pulumi_oci/generativeai/__init__.py +0 -16
  9. pulumi_oci/generativeai/_inputs.py +0 -1090
  10. pulumi_oci/generativeai/outputs.py +268 -2840
  11. pulumi_oci/goldengate/connection.py +78 -1065
  12. pulumi_oci/goldengate/deployment.py +7 -7
  13. pulumi_oci/goldengate/deployment_backup.py +0 -49
  14. pulumi_oci/goldengate/get_connection.py +7 -288
  15. pulumi_oci/goldengate/get_deployment.py +1 -1
  16. pulumi_oci/goldengate/get_deployment_backup.py +1 -15
  17. pulumi_oci/goldengate/outputs.py +3 -240
  18. pulumi_oci/pulumi-plugin.json +1 -1
  19. {pulumi_oci-2.17.0.dist-info → pulumi_oci-2.17.0a1731653778.dist-info}/METADATA +1 -1
  20. {pulumi_oci-2.17.0.dist-info → pulumi_oci-2.17.0a1731653778.dist-info}/RECORD +22 -38
  21. pulumi_oci/generativeai/agent_agent.py +0 -665
  22. pulumi_oci/generativeai/agent_agent_endpoint.py +0 -888
  23. pulumi_oci/generativeai/agent_data_ingestion_job.py +0 -647
  24. pulumi_oci/generativeai/agent_data_source.py +0 -697
  25. pulumi_oci/generativeai/agent_knowledge_base.py +0 -659
  26. pulumi_oci/generativeai/get_agent_agent.py +0 -285
  27. pulumi_oci/generativeai/get_agent_agent_endpoint.py +0 -342
  28. pulumi_oci/generativeai/get_agent_agent_endpoints.py +0 -217
  29. pulumi_oci/generativeai/get_agent_agents.py +0 -195
  30. pulumi_oci/generativeai/get_agent_data_ingestion_job.py +0 -286
  31. pulumi_oci/generativeai/get_agent_data_ingestion_job_log_content.py +0 -117
  32. pulumi_oci/generativeai/get_agent_data_ingestion_jobs.py +0 -217
  33. pulumi_oci/generativeai/get_agent_data_source.py +0 -286
  34. pulumi_oci/generativeai/get_agent_data_sources.py +0 -217
  35. pulumi_oci/generativeai/get_agent_knowledge_base.py +0 -272
  36. pulumi_oci/generativeai/get_agent_knowledge_bases.py +0 -195
  37. {pulumi_oci-2.17.0.dist-info → pulumi_oci-2.17.0a1731653778.dist-info}/WHEEL +0 -0
  38. {pulumi_oci-2.17.0.dist-info → pulumi_oci-2.17.0a1731653778.dist-info}/top_level.txt +0 -0
@@ -16,60 +16,12 @@ from .. import _utilities
16
16
  from . import outputs
17
17
 
18
18
  __all__ = [
19
- 'AgentAgentEndpointContentModerationConfig',
20
- 'AgentAgentEndpointSessionConfig',
21
- 'AgentDataIngestionJobDataIngestionJobStatistic',
22
- 'AgentDataSourceDataSourceConfig',
23
- 'AgentDataSourceDataSourceConfigObjectStoragePrefix',
24
- 'AgentKnowledgeBaseIndexConfig',
25
- 'AgentKnowledgeBaseIndexConfigDatabaseConnection',
26
- 'AgentKnowledgeBaseIndexConfigDatabaseFunction',
27
- 'AgentKnowledgeBaseIndexConfigIndex',
28
- 'AgentKnowledgeBaseIndexConfigIndexSchema',
29
- 'AgentKnowledgeBaseIndexConfigSecretDetail',
30
19
  'DedicatedAiClusterCapacity',
31
20
  'EndpointContentModerationConfig',
32
21
  'ModelFineTuneDetails',
33
22
  'ModelFineTuneDetailsTrainingConfig',
34
23
  'ModelFineTuneDetailsTrainingDataset',
35
24
  'ModelModelMetric',
36
- 'GetAgentAgentEndpointContentModerationConfigResult',
37
- 'GetAgentAgentEndpointSessionConfigResult',
38
- 'GetAgentAgentEndpointsAgentEndpointCollectionResult',
39
- 'GetAgentAgentEndpointsAgentEndpointCollectionItemResult',
40
- 'GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfigResult',
41
- 'GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfigResult',
42
- 'GetAgentAgentEndpointsFilterResult',
43
- 'GetAgentAgentsAgentCollectionResult',
44
- 'GetAgentAgentsAgentCollectionItemResult',
45
- 'GetAgentAgentsFilterResult',
46
- 'GetAgentDataIngestionJobDataIngestionJobStatisticResult',
47
- 'GetAgentDataIngestionJobsDataIngestionJobCollectionResult',
48
- 'GetAgentDataIngestionJobsDataIngestionJobCollectionItemResult',
49
- 'GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatisticResult',
50
- 'GetAgentDataIngestionJobsFilterResult',
51
- 'GetAgentDataSourceDataSourceConfigResult',
52
- 'GetAgentDataSourceDataSourceConfigObjectStoragePrefixResult',
53
- 'GetAgentDataSourcesDataSourceCollectionResult',
54
- 'GetAgentDataSourcesDataSourceCollectionItemResult',
55
- 'GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigResult',
56
- 'GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefixResult',
57
- 'GetAgentDataSourcesFilterResult',
58
- 'GetAgentKnowledgeBaseIndexConfigResult',
59
- 'GetAgentKnowledgeBaseIndexConfigDatabaseConnectionResult',
60
- 'GetAgentKnowledgeBaseIndexConfigDatabaseFunctionResult',
61
- 'GetAgentKnowledgeBaseIndexConfigIndexResult',
62
- 'GetAgentKnowledgeBaseIndexConfigIndexSchemaResult',
63
- 'GetAgentKnowledgeBaseIndexConfigSecretDetailResult',
64
- 'GetAgentKnowledgeBasesFilterResult',
65
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionResult',
66
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemResult',
67
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigResult',
68
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnectionResult',
69
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunctionResult',
70
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexResult',
71
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchemaResult',
72
- 'GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetailResult',
73
25
  'GetDedicatedAiClusterCapacityResult',
74
26
  'GetDedicatedAiClustersDedicatedAiClusterCollectionResult',
75
27
  'GetDedicatedAiClustersDedicatedAiClusterCollectionItemResult',
@@ -94,3003 +46,479 @@ __all__ = [
94
46
  ]
95
47
 
96
48
  @pulumi.output_type
97
- class AgentAgentEndpointContentModerationConfig(dict):
49
+ class DedicatedAiClusterCapacity(dict):
98
50
  @staticmethod
99
51
  def __key_warning(key: str):
100
52
  suggest = None
101
- if key == "shouldEnableOnInput":
102
- suggest = "should_enable_on_input"
103
- elif key == "shouldEnableOnOutput":
104
- suggest = "should_enable_on_output"
53
+ if key == "capacityType":
54
+ suggest = "capacity_type"
55
+ elif key == "totalEndpointCapacity":
56
+ suggest = "total_endpoint_capacity"
57
+ elif key == "usedEndpointCapacity":
58
+ suggest = "used_endpoint_capacity"
105
59
 
106
60
  if suggest:
107
- pulumi.log.warn(f"Key '{key}' not found in AgentAgentEndpointContentModerationConfig. Access the value via the '{suggest}' property getter instead.")
61
+ pulumi.log.warn(f"Key '{key}' not found in DedicatedAiClusterCapacity. Access the value via the '{suggest}' property getter instead.")
108
62
 
109
63
  def __getitem__(self, key: str) -> Any:
110
- AgentAgentEndpointContentModerationConfig.__key_warning(key)
64
+ DedicatedAiClusterCapacity.__key_warning(key)
111
65
  return super().__getitem__(key)
112
66
 
113
67
  def get(self, key: str, default = None) -> Any:
114
- AgentAgentEndpointContentModerationConfig.__key_warning(key)
68
+ DedicatedAiClusterCapacity.__key_warning(key)
115
69
  return super().get(key, default)
116
70
 
117
71
  def __init__(__self__, *,
118
- should_enable_on_input: Optional[bool] = None,
119
- should_enable_on_output: Optional[bool] = None):
72
+ capacity_type: Optional[str] = None,
73
+ total_endpoint_capacity: Optional[int] = None,
74
+ used_endpoint_capacity: Optional[int] = None):
75
+ """
76
+ :param str capacity_type: The type of the dedicated AI cluster capacity.
77
+ :param int total_endpoint_capacity: The total number of endpoints that can be hosted on this dedicated AI cluster.
78
+ :param int used_endpoint_capacity: The number of endpoints hosted on this dedicated AI cluster.
79
+ """
80
+ if capacity_type is not None:
81
+ pulumi.set(__self__, "capacity_type", capacity_type)
82
+ if total_endpoint_capacity is not None:
83
+ pulumi.set(__self__, "total_endpoint_capacity", total_endpoint_capacity)
84
+ if used_endpoint_capacity is not None:
85
+ pulumi.set(__self__, "used_endpoint_capacity", used_endpoint_capacity)
86
+
87
+ @property
88
+ @pulumi.getter(name="capacityType")
89
+ def capacity_type(self) -> Optional[str]:
120
90
  """
121
- :param bool should_enable_on_input: (Updatable) A flag to enable or disable content moderation on input.
122
- :param bool should_enable_on_output: (Updatable) A flag to enable or disable content moderation on output.
91
+ The type of the dedicated AI cluster capacity.
123
92
  """
124
- if should_enable_on_input is not None:
125
- pulumi.set(__self__, "should_enable_on_input", should_enable_on_input)
126
- if should_enable_on_output is not None:
127
- pulumi.set(__self__, "should_enable_on_output", should_enable_on_output)
93
+ return pulumi.get(self, "capacity_type")
128
94
 
129
95
  @property
130
- @pulumi.getter(name="shouldEnableOnInput")
131
- def should_enable_on_input(self) -> Optional[bool]:
96
+ @pulumi.getter(name="totalEndpointCapacity")
97
+ def total_endpoint_capacity(self) -> Optional[int]:
132
98
  """
133
- (Updatable) A flag to enable or disable content moderation on input.
99
+ The total number of endpoints that can be hosted on this dedicated AI cluster.
134
100
  """
135
- return pulumi.get(self, "should_enable_on_input")
101
+ return pulumi.get(self, "total_endpoint_capacity")
136
102
 
137
103
  @property
138
- @pulumi.getter(name="shouldEnableOnOutput")
139
- def should_enable_on_output(self) -> Optional[bool]:
104
+ @pulumi.getter(name="usedEndpointCapacity")
105
+ def used_endpoint_capacity(self) -> Optional[int]:
140
106
  """
141
- (Updatable) A flag to enable or disable content moderation on output.
107
+ The number of endpoints hosted on this dedicated AI cluster.
142
108
  """
143
- return pulumi.get(self, "should_enable_on_output")
109
+ return pulumi.get(self, "used_endpoint_capacity")
144
110
 
145
111
 
146
112
  @pulumi.output_type
147
- class AgentAgentEndpointSessionConfig(dict):
113
+ class EndpointContentModerationConfig(dict):
148
114
  @staticmethod
149
115
  def __key_warning(key: str):
150
116
  suggest = None
151
- if key == "idleTimeoutInSeconds":
152
- suggest = "idle_timeout_in_seconds"
117
+ if key == "isEnabled":
118
+ suggest = "is_enabled"
153
119
 
154
120
  if suggest:
155
- pulumi.log.warn(f"Key '{key}' not found in AgentAgentEndpointSessionConfig. Access the value via the '{suggest}' property getter instead.")
121
+ pulumi.log.warn(f"Key '{key}' not found in EndpointContentModerationConfig. Access the value via the '{suggest}' property getter instead.")
156
122
 
157
123
  def __getitem__(self, key: str) -> Any:
158
- AgentAgentEndpointSessionConfig.__key_warning(key)
124
+ EndpointContentModerationConfig.__key_warning(key)
159
125
  return super().__getitem__(key)
160
126
 
161
127
  def get(self, key: str, default = None) -> Any:
162
- AgentAgentEndpointSessionConfig.__key_warning(key)
128
+ EndpointContentModerationConfig.__key_warning(key)
163
129
  return super().get(key, default)
164
130
 
165
131
  def __init__(__self__, *,
166
- idle_timeout_in_seconds: Optional[int] = None):
132
+ is_enabled: bool):
167
133
  """
168
- :param int idle_timeout_in_seconds: (Updatable) The session will become inactive after this timeout.
134
+ :param bool is_enabled: (Updatable) Whether to enable the content moderation feature.
169
135
  """
170
- if idle_timeout_in_seconds is not None:
171
- pulumi.set(__self__, "idle_timeout_in_seconds", idle_timeout_in_seconds)
136
+ pulumi.set(__self__, "is_enabled", is_enabled)
172
137
 
173
138
  @property
174
- @pulumi.getter(name="idleTimeoutInSeconds")
175
- def idle_timeout_in_seconds(self) -> Optional[int]:
139
+ @pulumi.getter(name="isEnabled")
140
+ def is_enabled(self) -> bool:
176
141
  """
177
- (Updatable) The session will become inactive after this timeout.
142
+ (Updatable) Whether to enable the content moderation feature.
178
143
  """
179
- return pulumi.get(self, "idle_timeout_in_seconds")
144
+ return pulumi.get(self, "is_enabled")
180
145
 
181
146
 
182
147
  @pulumi.output_type
183
- class AgentDataIngestionJobDataIngestionJobStatistic(dict):
148
+ class ModelFineTuneDetails(dict):
184
149
  @staticmethod
185
150
  def __key_warning(key: str):
186
151
  suggest = None
187
- if key == "durationInSeconds":
188
- suggest = "duration_in_seconds"
189
- elif key == "numberOfFailedFiles":
190
- suggest = "number_of_failed_files"
191
- elif key == "numberOfIngestedFiles":
192
- suggest = "number_of_ingested_files"
152
+ if key == "dedicatedAiClusterId":
153
+ suggest = "dedicated_ai_cluster_id"
154
+ elif key == "trainingDataset":
155
+ suggest = "training_dataset"
156
+ elif key == "trainingConfig":
157
+ suggest = "training_config"
193
158
 
194
159
  if suggest:
195
- pulumi.log.warn(f"Key '{key}' not found in AgentDataIngestionJobDataIngestionJobStatistic. Access the value via the '{suggest}' property getter instead.")
160
+ pulumi.log.warn(f"Key '{key}' not found in ModelFineTuneDetails. Access the value via the '{suggest}' property getter instead.")
196
161
 
197
162
  def __getitem__(self, key: str) -> Any:
198
- AgentDataIngestionJobDataIngestionJobStatistic.__key_warning(key)
163
+ ModelFineTuneDetails.__key_warning(key)
199
164
  return super().__getitem__(key)
200
165
 
201
166
  def get(self, key: str, default = None) -> Any:
202
- AgentDataIngestionJobDataIngestionJobStatistic.__key_warning(key)
167
+ ModelFineTuneDetails.__key_warning(key)
203
168
  return super().get(key, default)
204
169
 
205
170
  def __init__(__self__, *,
206
- duration_in_seconds: Optional[int] = None,
207
- number_of_failed_files: Optional[int] = None,
208
- number_of_ingested_files: Optional[int] = None):
171
+ dedicated_ai_cluster_id: str,
172
+ training_dataset: 'outputs.ModelFineTuneDetailsTrainingDataset',
173
+ training_config: Optional['outputs.ModelFineTuneDetailsTrainingConfig'] = None):
209
174
  """
210
- :param int duration_in_seconds: The duration of this ingestion job.
211
- :param int number_of_failed_files: The number of files that have failed during the ingestion.
212
- :param int number_of_ingested_files: The number of files that have been successfully ingested during the ingestion.
175
+ :param str dedicated_ai_cluster_id: The OCID of the dedicated AI cluster this fine-tuning runs on.
176
+ :param 'ModelFineTuneDetailsTrainingDatasetArgs' training_dataset: The dataset used to fine-tune the model.
177
+
178
+ Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format: `{"prompt": "<first prompt>", "completion": "<expected completion given first prompt>"}`
179
+ :param 'ModelFineTuneDetailsTrainingConfigArgs' training_config: The fine-tuning method and hyperparameters used for fine-tuning a custom model.
213
180
  """
214
- if duration_in_seconds is not None:
215
- pulumi.set(__self__, "duration_in_seconds", duration_in_seconds)
216
- if number_of_failed_files is not None:
217
- pulumi.set(__self__, "number_of_failed_files", number_of_failed_files)
218
- if number_of_ingested_files is not None:
219
- pulumi.set(__self__, "number_of_ingested_files", number_of_ingested_files)
181
+ pulumi.set(__self__, "dedicated_ai_cluster_id", dedicated_ai_cluster_id)
182
+ pulumi.set(__self__, "training_dataset", training_dataset)
183
+ if training_config is not None:
184
+ pulumi.set(__self__, "training_config", training_config)
220
185
 
221
186
  @property
222
- @pulumi.getter(name="durationInSeconds")
223
- def duration_in_seconds(self) -> Optional[int]:
187
+ @pulumi.getter(name="dedicatedAiClusterId")
188
+ def dedicated_ai_cluster_id(self) -> str:
224
189
  """
225
- The duration of this ingestion job.
190
+ The OCID of the dedicated AI cluster this fine-tuning runs on.
226
191
  """
227
- return pulumi.get(self, "duration_in_seconds")
192
+ return pulumi.get(self, "dedicated_ai_cluster_id")
228
193
 
229
194
  @property
230
- @pulumi.getter(name="numberOfFailedFiles")
231
- def number_of_failed_files(self) -> Optional[int]:
195
+ @pulumi.getter(name="trainingDataset")
196
+ def training_dataset(self) -> 'outputs.ModelFineTuneDetailsTrainingDataset':
232
197
  """
233
- The number of files that have failed during the ingestion.
198
+ The dataset used to fine-tune the model.
199
+
200
+ Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format: `{"prompt": "<first prompt>", "completion": "<expected completion given first prompt>"}`
234
201
  """
235
- return pulumi.get(self, "number_of_failed_files")
202
+ return pulumi.get(self, "training_dataset")
236
203
 
237
204
  @property
238
- @pulumi.getter(name="numberOfIngestedFiles")
239
- def number_of_ingested_files(self) -> Optional[int]:
205
+ @pulumi.getter(name="trainingConfig")
206
+ def training_config(self) -> Optional['outputs.ModelFineTuneDetailsTrainingConfig']:
240
207
  """
241
- The number of files that have been successfully ingested during the ingestion.
208
+ The fine-tuning method and hyperparameters used for fine-tuning a custom model.
242
209
  """
243
- return pulumi.get(self, "number_of_ingested_files")
210
+ return pulumi.get(self, "training_config")
244
211
 
245
212
 
246
213
  @pulumi.output_type
247
- class AgentDataSourceDataSourceConfig(dict):
214
+ class ModelFineTuneDetailsTrainingConfig(dict):
248
215
  @staticmethod
249
216
  def __key_warning(key: str):
250
217
  suggest = None
251
- if key == "dataSourceConfigType":
252
- suggest = "data_source_config_type"
253
- elif key == "objectStoragePrefixes":
254
- suggest = "object_storage_prefixes"
218
+ if key == "trainingConfigType":
219
+ suggest = "training_config_type"
220
+ elif key == "earlyStoppingPatience":
221
+ suggest = "early_stopping_patience"
222
+ elif key == "earlyStoppingThreshold":
223
+ suggest = "early_stopping_threshold"
224
+ elif key == "learningRate":
225
+ suggest = "learning_rate"
226
+ elif key == "logModelMetricsIntervalInSteps":
227
+ suggest = "log_model_metrics_interval_in_steps"
228
+ elif key == "loraAlpha":
229
+ suggest = "lora_alpha"
230
+ elif key == "loraDropout":
231
+ suggest = "lora_dropout"
232
+ elif key == "loraR":
233
+ suggest = "lora_r"
234
+ elif key == "numOfLastLayers":
235
+ suggest = "num_of_last_layers"
236
+ elif key == "totalTrainingEpochs":
237
+ suggest = "total_training_epochs"
238
+ elif key == "trainingBatchSize":
239
+ suggest = "training_batch_size"
255
240
 
256
241
  if suggest:
257
- pulumi.log.warn(f"Key '{key}' not found in AgentDataSourceDataSourceConfig. Access the value via the '{suggest}' property getter instead.")
242
+ pulumi.log.warn(f"Key '{key}' not found in ModelFineTuneDetailsTrainingConfig. Access the value via the '{suggest}' property getter instead.")
258
243
 
259
244
  def __getitem__(self, key: str) -> Any:
260
- AgentDataSourceDataSourceConfig.__key_warning(key)
245
+ ModelFineTuneDetailsTrainingConfig.__key_warning(key)
261
246
  return super().__getitem__(key)
262
247
 
263
248
  def get(self, key: str, default = None) -> Any:
264
- AgentDataSourceDataSourceConfig.__key_warning(key)
249
+ ModelFineTuneDetailsTrainingConfig.__key_warning(key)
265
250
  return super().get(key, default)
266
251
 
267
252
  def __init__(__self__, *,
268
- data_source_config_type: str,
269
- object_storage_prefixes: Sequence['outputs.AgentDataSourceDataSourceConfigObjectStoragePrefix']):
253
+ training_config_type: str,
254
+ early_stopping_patience: Optional[int] = None,
255
+ early_stopping_threshold: Optional[float] = None,
256
+ learning_rate: Optional[float] = None,
257
+ log_model_metrics_interval_in_steps: Optional[int] = None,
258
+ lora_alpha: Optional[int] = None,
259
+ lora_dropout: Optional[float] = None,
260
+ lora_r: Optional[int] = None,
261
+ num_of_last_layers: Optional[int] = None,
262
+ total_training_epochs: Optional[int] = None,
263
+ training_batch_size: Optional[int] = None):
270
264
  """
271
- :param str data_source_config_type: (Updatable) The type of the tool. The allowed values are:
272
- * `OCI_OBJECT_STORAGE`: The data source is Oracle Cloud Infrastructure Object Storage.
273
- :param Sequence['AgentDataSourceDataSourceConfigObjectStoragePrefixArgs'] object_storage_prefixes: (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
265
+ :param str training_config_type: The fine-tuning method for training a custom model.
266
+ :param int early_stopping_patience: Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
267
+ :param float early_stopping_threshold: How much the loss must improve to prevent early stopping.
268
+ :param float learning_rate: The initial learning rate to be used during training
269
+ :param int log_model_metrics_interval_in_steps: Determines how frequently to log model metrics.
270
+
271
+ Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
272
+ :param int lora_alpha: This parameter represents the scaling factor for the weight matrices in LoRA.
273
+ :param float lora_dropout: This parameter indicates the dropout probability for LoRA layers.
274
+ :param int lora_r: This parameter represents the LoRA rank of the update matrices.
275
+ :param int num_of_last_layers: The number of last layers to be fine-tuned.
276
+ :param int total_training_epochs: The maximum number of training epochs to run for.
277
+ :param int training_batch_size: The batch size used during training.
274
278
  """
275
- pulumi.set(__self__, "data_source_config_type", data_source_config_type)
276
- pulumi.set(__self__, "object_storage_prefixes", object_storage_prefixes)
279
+ pulumi.set(__self__, "training_config_type", training_config_type)
280
+ if early_stopping_patience is not None:
281
+ pulumi.set(__self__, "early_stopping_patience", early_stopping_patience)
282
+ if early_stopping_threshold is not None:
283
+ pulumi.set(__self__, "early_stopping_threshold", early_stopping_threshold)
284
+ if learning_rate is not None:
285
+ pulumi.set(__self__, "learning_rate", learning_rate)
286
+ if log_model_metrics_interval_in_steps is not None:
287
+ pulumi.set(__self__, "log_model_metrics_interval_in_steps", log_model_metrics_interval_in_steps)
288
+ if lora_alpha is not None:
289
+ pulumi.set(__self__, "lora_alpha", lora_alpha)
290
+ if lora_dropout is not None:
291
+ pulumi.set(__self__, "lora_dropout", lora_dropout)
292
+ if lora_r is not None:
293
+ pulumi.set(__self__, "lora_r", lora_r)
294
+ if num_of_last_layers is not None:
295
+ pulumi.set(__self__, "num_of_last_layers", num_of_last_layers)
296
+ if total_training_epochs is not None:
297
+ pulumi.set(__self__, "total_training_epochs", total_training_epochs)
298
+ if training_batch_size is not None:
299
+ pulumi.set(__self__, "training_batch_size", training_batch_size)
277
300
 
278
301
  @property
279
- @pulumi.getter(name="dataSourceConfigType")
280
- def data_source_config_type(self) -> str:
302
+ @pulumi.getter(name="trainingConfigType")
303
+ def training_config_type(self) -> str:
281
304
  """
282
- (Updatable) The type of the tool. The allowed values are:
283
- * `OCI_OBJECT_STORAGE`: The data source is Oracle Cloud Infrastructure Object Storage.
305
+ The fine-tuning method for training a custom model.
284
306
  """
285
- return pulumi.get(self, "data_source_config_type")
307
+ return pulumi.get(self, "training_config_type")
286
308
 
287
309
  @property
288
- @pulumi.getter(name="objectStoragePrefixes")
289
- def object_storage_prefixes(self) -> Sequence['outputs.AgentDataSourceDataSourceConfigObjectStoragePrefix']:
290
- """
291
- (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
292
- """
293
- return pulumi.get(self, "object_storage_prefixes")
294
-
295
-
296
- @pulumi.output_type
297
- class AgentDataSourceDataSourceConfigObjectStoragePrefix(dict):
298
- def __init__(__self__, *,
299
- bucket: str,
300
- namespace: str,
301
- prefix: Optional[str] = None):
310
+ @pulumi.getter(name="earlyStoppingPatience")
311
+ def early_stopping_patience(self) -> Optional[int]:
302
312
  """
303
- :param str bucket: (Updatable) The bucket name of an object.
304
- :param str namespace: (Updatable) The namespace name of an object.
305
- :param str prefix: (Updatable) The name of the object (file) or prefix (folder).
313
+ Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
306
314
  """
307
- pulumi.set(__self__, "bucket", bucket)
308
- pulumi.set(__self__, "namespace", namespace)
309
- if prefix is not None:
310
- pulumi.set(__self__, "prefix", prefix)
315
+ return pulumi.get(self, "early_stopping_patience")
311
316
 
312
317
  @property
313
- @pulumi.getter
314
- def bucket(self) -> str:
318
+ @pulumi.getter(name="earlyStoppingThreshold")
319
+ def early_stopping_threshold(self) -> Optional[float]:
315
320
  """
316
- (Updatable) The bucket name of an object.
321
+ How much the loss must improve to prevent early stopping.
317
322
  """
318
- return pulumi.get(self, "bucket")
323
+ return pulumi.get(self, "early_stopping_threshold")
319
324
 
320
325
  @property
321
- @pulumi.getter
322
- def namespace(self) -> str:
326
+ @pulumi.getter(name="learningRate")
327
+ def learning_rate(self) -> Optional[float]:
323
328
  """
324
- (Updatable) The namespace name of an object.
329
+ The initial learning rate to be used during training
325
330
  """
326
- return pulumi.get(self, "namespace")
331
+ return pulumi.get(self, "learning_rate")
327
332
 
328
333
  @property
329
- @pulumi.getter
330
- def prefix(self) -> Optional[str]:
331
- """
332
- (Updatable) The name of the object (file) or prefix (folder).
333
- """
334
- return pulumi.get(self, "prefix")
335
-
336
-
337
- @pulumi.output_type
338
- class AgentKnowledgeBaseIndexConfig(dict):
339
- @staticmethod
340
- def __key_warning(key: str):
341
- suggest = None
342
- if key == "indexConfigType":
343
- suggest = "index_config_type"
344
- elif key == "clusterId":
345
- suggest = "cluster_id"
346
- elif key == "databaseConnection":
347
- suggest = "database_connection"
348
- elif key == "databaseFunctions":
349
- suggest = "database_functions"
350
- elif key == "secretDetail":
351
- suggest = "secret_detail"
352
- elif key == "shouldEnableHybridSearch":
353
- suggest = "should_enable_hybrid_search"
354
-
355
- if suggest:
356
- pulumi.log.warn(f"Key '{key}' not found in AgentKnowledgeBaseIndexConfig. Access the value via the '{suggest}' property getter instead.")
357
-
358
- def __getitem__(self, key: str) -> Any:
359
- AgentKnowledgeBaseIndexConfig.__key_warning(key)
360
- return super().__getitem__(key)
361
-
362
- def get(self, key: str, default = None) -> Any:
363
- AgentKnowledgeBaseIndexConfig.__key_warning(key)
364
- return super().get(key, default)
365
-
366
- def __init__(__self__, *,
367
- index_config_type: str,
368
- cluster_id: Optional[str] = None,
369
- database_connection: Optional['outputs.AgentKnowledgeBaseIndexConfigDatabaseConnection'] = None,
370
- database_functions: Optional[Sequence['outputs.AgentKnowledgeBaseIndexConfigDatabaseFunction']] = None,
371
- indexes: Optional[Sequence['outputs.AgentKnowledgeBaseIndexConfigIndex']] = None,
372
- secret_detail: Optional['outputs.AgentKnowledgeBaseIndexConfigSecretDetail'] = None,
373
- should_enable_hybrid_search: Optional[bool] = None):
374
- """
375
- :param str index_config_type: (Updatable) The type of index. The allowed values are:
376
- * `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
377
- * `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
378
- * `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
379
- :param str cluster_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
380
- :param 'AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs' database_connection: (Updatable) **DatabaseConnection**
381
-
382
- The connection type for Databases.
383
- :param Sequence['AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs'] database_functions: (Updatable) Array of Database functions to be used.
384
- :param Sequence['AgentKnowledgeBaseIndexConfigIndexArgs'] indexes: (Updatable) Index configuration for open search.
385
- :param 'AgentKnowledgeBaseIndexConfigSecretDetailArgs' secret_detail: (Updatable) **SecretDetail**
386
-
387
- The details of configured security configuration on OpenSearch.
388
- :param bool should_enable_hybrid_search: (Updatable) Whether to enable Hybrid search in service managed OpenSearch.
389
-
390
-
391
- ** IMPORTANT **
392
- Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
334
+ @pulumi.getter(name="logModelMetricsIntervalInSteps")
335
+ def log_model_metrics_interval_in_steps(self) -> Optional[int]:
393
336
  """
394
- pulumi.set(__self__, "index_config_type", index_config_type)
395
- if cluster_id is not None:
396
- pulumi.set(__self__, "cluster_id", cluster_id)
397
- if database_connection is not None:
398
- pulumi.set(__self__, "database_connection", database_connection)
399
- if database_functions is not None:
400
- pulumi.set(__self__, "database_functions", database_functions)
401
- if indexes is not None:
402
- pulumi.set(__self__, "indexes", indexes)
403
- if secret_detail is not None:
404
- pulumi.set(__self__, "secret_detail", secret_detail)
405
- if should_enable_hybrid_search is not None:
406
- pulumi.set(__self__, "should_enable_hybrid_search", should_enable_hybrid_search)
337
+ Determines how frequently to log model metrics.
407
338
 
408
- @property
409
- @pulumi.getter(name="indexConfigType")
410
- def index_config_type(self) -> str:
411
- """
412
- (Updatable) The type of index. The allowed values are:
413
- * `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
414
- * `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
415
- * `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
339
+ Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
416
340
  """
417
- return pulumi.get(self, "index_config_type")
341
+ return pulumi.get(self, "log_model_metrics_interval_in_steps")
418
342
 
419
343
  @property
420
- @pulumi.getter(name="clusterId")
421
- def cluster_id(self) -> Optional[str]:
344
+ @pulumi.getter(name="loraAlpha")
345
+ def lora_alpha(self) -> Optional[int]:
422
346
  """
423
- (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
347
+ This parameter represents the scaling factor for the weight matrices in LoRA.
424
348
  """
425
- return pulumi.get(self, "cluster_id")
349
+ return pulumi.get(self, "lora_alpha")
426
350
 
427
351
  @property
428
- @pulumi.getter(name="databaseConnection")
429
- def database_connection(self) -> Optional['outputs.AgentKnowledgeBaseIndexConfigDatabaseConnection']:
352
+ @pulumi.getter(name="loraDropout")
353
+ def lora_dropout(self) -> Optional[float]:
430
354
  """
431
- (Updatable) **DatabaseConnection**
432
-
433
- The connection type for Databases.
355
+ This parameter indicates the dropout probability for LoRA layers.
434
356
  """
435
- return pulumi.get(self, "database_connection")
357
+ return pulumi.get(self, "lora_dropout")
436
358
 
437
359
  @property
438
- @pulumi.getter(name="databaseFunctions")
439
- def database_functions(self) -> Optional[Sequence['outputs.AgentKnowledgeBaseIndexConfigDatabaseFunction']]:
360
+ @pulumi.getter(name="loraR")
361
+ def lora_r(self) -> Optional[int]:
440
362
  """
441
- (Updatable) Array of Database functions to be used.
363
+ This parameter represents the LoRA rank of the update matrices.
442
364
  """
443
- return pulumi.get(self, "database_functions")
365
+ return pulumi.get(self, "lora_r")
444
366
 
445
367
  @property
446
- @pulumi.getter
447
- def indexes(self) -> Optional[Sequence['outputs.AgentKnowledgeBaseIndexConfigIndex']]:
368
+ @pulumi.getter(name="numOfLastLayers")
369
+ def num_of_last_layers(self) -> Optional[int]:
448
370
  """
449
- (Updatable) Index configuration for open search.
371
+ The number of last layers to be fine-tuned.
450
372
  """
451
- return pulumi.get(self, "indexes")
373
+ return pulumi.get(self, "num_of_last_layers")
452
374
 
453
375
  @property
454
- @pulumi.getter(name="secretDetail")
455
- def secret_detail(self) -> Optional['outputs.AgentKnowledgeBaseIndexConfigSecretDetail']:
376
+ @pulumi.getter(name="totalTrainingEpochs")
377
+ def total_training_epochs(self) -> Optional[int]:
456
378
  """
457
- (Updatable) **SecretDetail**
458
-
459
- The details of configured security configuration on OpenSearch.
379
+ The maximum number of training epochs to run for.
460
380
  """
461
- return pulumi.get(self, "secret_detail")
381
+ return pulumi.get(self, "total_training_epochs")
462
382
 
463
383
  @property
464
- @pulumi.getter(name="shouldEnableHybridSearch")
465
- def should_enable_hybrid_search(self) -> Optional[bool]:
384
+ @pulumi.getter(name="trainingBatchSize")
385
+ def training_batch_size(self) -> Optional[int]:
466
386
  """
467
- (Updatable) Whether to enable Hybrid search in service managed OpenSearch.
468
-
469
-
470
- ** IMPORTANT **
471
- Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
387
+ The batch size used during training.
472
388
  """
473
- return pulumi.get(self, "should_enable_hybrid_search")
389
+ return pulumi.get(self, "training_batch_size")
474
390
 
475
391
 
476
392
  @pulumi.output_type
477
- class AgentKnowledgeBaseIndexConfigDatabaseConnection(dict):
393
+ class ModelFineTuneDetailsTrainingDataset(dict):
478
394
  @staticmethod
479
395
  def __key_warning(key: str):
480
396
  suggest = None
481
- if key == "connectionId":
482
- suggest = "connection_id"
483
- elif key == "connectionType":
484
- suggest = "connection_type"
397
+ if key == "datasetType":
398
+ suggest = "dataset_type"
485
399
 
486
400
  if suggest:
487
- pulumi.log.warn(f"Key '{key}' not found in AgentKnowledgeBaseIndexConfigDatabaseConnection. Access the value via the '{suggest}' property getter instead.")
401
+ pulumi.log.warn(f"Key '{key}' not found in ModelFineTuneDetailsTrainingDataset. Access the value via the '{suggest}' property getter instead.")
488
402
 
489
403
  def __getitem__(self, key: str) -> Any:
490
- AgentKnowledgeBaseIndexConfigDatabaseConnection.__key_warning(key)
404
+ ModelFineTuneDetailsTrainingDataset.__key_warning(key)
491
405
  return super().__getitem__(key)
492
406
 
493
407
  def get(self, key: str, default = None) -> Any:
494
- AgentKnowledgeBaseIndexConfigDatabaseConnection.__key_warning(key)
408
+ ModelFineTuneDetailsTrainingDataset.__key_warning(key)
495
409
  return super().get(key, default)
496
410
 
497
411
  def __init__(__self__, *,
498
- connection_id: str,
499
- connection_type: str):
500
- """
501
- :param str connection_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
502
- :param str connection_type: (Updatable) The type of Database connection. The allowed values are:
503
- * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
504
- """
505
- pulumi.set(__self__, "connection_id", connection_id)
506
- pulumi.set(__self__, "connection_type", connection_type)
507
-
508
- @property
509
- @pulumi.getter(name="connectionId")
510
- def connection_id(self) -> str:
511
- """
512
- (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
513
- """
514
- return pulumi.get(self, "connection_id")
515
-
516
- @property
517
- @pulumi.getter(name="connectionType")
518
- def connection_type(self) -> str:
519
- """
520
- (Updatable) The type of Database connection. The allowed values are:
521
- * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
522
- """
523
- return pulumi.get(self, "connection_type")
524
-
525
-
526
- @pulumi.output_type
527
- class AgentKnowledgeBaseIndexConfigDatabaseFunction(dict):
528
- def __init__(__self__, *,
529
- name: Optional[str] = None):
412
+ bucket: str,
413
+ dataset_type: str,
414
+ namespace: str,
415
+ object: str):
530
416
  """
531
- :param str name: (Updatable) The name of the Database function.
417
+ :param str bucket: The Object Storage bucket name.
418
+ :param str dataset_type: The type of the data asset.
419
+ :param str namespace: The Object Storage namespace.
420
+ :param str object: The Object Storage object name.
532
421
  """
533
- if name is not None:
534
- pulumi.set(__self__, "name", name)
422
+ pulumi.set(__self__, "bucket", bucket)
423
+ pulumi.set(__self__, "dataset_type", dataset_type)
424
+ pulumi.set(__self__, "namespace", namespace)
425
+ pulumi.set(__self__, "object", object)
535
426
 
536
427
  @property
537
428
  @pulumi.getter
538
- def name(self) -> Optional[str]:
539
- """
540
- (Updatable) The name of the Database function.
541
- """
542
- return pulumi.get(self, "name")
543
-
544
-
545
- @pulumi.output_type
546
- class AgentKnowledgeBaseIndexConfigIndex(dict):
547
- def __init__(__self__, *,
548
- name: Optional[str] = None,
549
- schema: Optional['outputs.AgentKnowledgeBaseIndexConfigIndexSchema'] = None):
429
+ def bucket(self) -> str:
550
430
  """
551
- :param str name: (Updatable) The index name in opensearch.
552
- :param 'AgentKnowledgeBaseIndexConfigIndexSchemaArgs' schema: (Updatable) **IndexSchema**
553
-
554
- The index schema details.
431
+ The Object Storage bucket name.
555
432
  """
556
- if name is not None:
557
- pulumi.set(__self__, "name", name)
558
- if schema is not None:
559
- pulumi.set(__self__, "schema", schema)
433
+ return pulumi.get(self, "bucket")
560
434
 
561
435
  @property
562
- @pulumi.getter
563
- def name(self) -> Optional[str]:
436
+ @pulumi.getter(name="datasetType")
437
+ def dataset_type(self) -> str:
564
438
  """
565
- (Updatable) The index name in opensearch.
439
+ The type of the data asset.
566
440
  """
567
- return pulumi.get(self, "name")
441
+ return pulumi.get(self, "dataset_type")
568
442
 
569
443
  @property
570
444
  @pulumi.getter
571
- def schema(self) -> Optional['outputs.AgentKnowledgeBaseIndexConfigIndexSchema']:
572
- """
573
- (Updatable) **IndexSchema**
574
-
575
- The index schema details.
576
- """
577
- return pulumi.get(self, "schema")
578
-
579
-
580
- @pulumi.output_type
581
- class AgentKnowledgeBaseIndexConfigIndexSchema(dict):
582
- @staticmethod
583
- def __key_warning(key: str):
584
- suggest = None
585
- if key == "bodyKey":
586
- suggest = "body_key"
587
- elif key == "embeddingBodyKey":
588
- suggest = "embedding_body_key"
589
- elif key == "titleKey":
590
- suggest = "title_key"
591
- elif key == "urlKey":
592
- suggest = "url_key"
593
-
594
- if suggest:
595
- pulumi.log.warn(f"Key '{key}' not found in AgentKnowledgeBaseIndexConfigIndexSchema. Access the value via the '{suggest}' property getter instead.")
596
-
597
- def __getitem__(self, key: str) -> Any:
598
- AgentKnowledgeBaseIndexConfigIndexSchema.__key_warning(key)
599
- return super().__getitem__(key)
600
-
601
- def get(self, key: str, default = None) -> Any:
602
- AgentKnowledgeBaseIndexConfigIndexSchema.__key_warning(key)
603
- return super().get(key, default)
604
-
605
- def __init__(__self__, *,
606
- body_key: Optional[str] = None,
607
- embedding_body_key: Optional[str] = None,
608
- title_key: Optional[str] = None,
609
- url_key: Optional[str] = None):
610
- """
611
- :param str body_key: (Updatable) Body key name.
612
- :param str embedding_body_key: (Updatable) Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
613
- :param str title_key: (Updatable) Title key that stores the Title of a document, if available.
614
- :param str url_key: (Updatable) URL key that stores the URL of a document, if available.
615
- """
616
- if body_key is not None:
617
- pulumi.set(__self__, "body_key", body_key)
618
- if embedding_body_key is not None:
619
- pulumi.set(__self__, "embedding_body_key", embedding_body_key)
620
- if title_key is not None:
621
- pulumi.set(__self__, "title_key", title_key)
622
- if url_key is not None:
623
- pulumi.set(__self__, "url_key", url_key)
624
-
625
- @property
626
- @pulumi.getter(name="bodyKey")
627
- def body_key(self) -> Optional[str]:
628
- """
629
- (Updatable) Body key name.
630
- """
631
- return pulumi.get(self, "body_key")
632
-
633
- @property
634
- @pulumi.getter(name="embeddingBodyKey")
635
- def embedding_body_key(self) -> Optional[str]:
636
- """
637
- (Updatable) Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
638
- """
639
- return pulumi.get(self, "embedding_body_key")
640
-
641
- @property
642
- @pulumi.getter(name="titleKey")
643
- def title_key(self) -> Optional[str]:
644
- """
645
- (Updatable) Title key that stores the Title of a document, if available.
646
- """
647
- return pulumi.get(self, "title_key")
648
-
649
- @property
650
- @pulumi.getter(name="urlKey")
651
- def url_key(self) -> Optional[str]:
652
- """
653
- (Updatable) URL key that stores the URL of a document, if available.
445
+ def namespace(self) -> str:
654
446
  """
655
- return pulumi.get(self, "url_key")
656
-
657
-
658
- @pulumi.output_type
659
- class AgentKnowledgeBaseIndexConfigSecretDetail(dict):
660
- @staticmethod
661
- def __key_warning(key: str):
662
- suggest = None
663
- if key == "vaultSecretId":
664
- suggest = "vault_secret_id"
665
- elif key == "clientId":
666
- suggest = "client_id"
667
- elif key == "idcsUrl":
668
- suggest = "idcs_url"
669
- elif key == "scopeUrl":
670
- suggest = "scope_url"
671
-
672
- if suggest:
673
- pulumi.log.warn(f"Key '{key}' not found in AgentKnowledgeBaseIndexConfigSecretDetail. Access the value via the '{suggest}' property getter instead.")
674
-
675
- def __getitem__(self, key: str) -> Any:
676
- AgentKnowledgeBaseIndexConfigSecretDetail.__key_warning(key)
677
- return super().__getitem__(key)
678
-
679
- def get(self, key: str, default = None) -> Any:
680
- AgentKnowledgeBaseIndexConfigSecretDetail.__key_warning(key)
681
- return super().get(key, default)
682
-
683
- def __init__(__self__, *,
684
- type: str,
685
- vault_secret_id: str,
686
- client_id: Optional[str] = None,
687
- idcs_url: Optional[str] = None,
688
- scope_url: Optional[str] = None):
689
- """
690
- :param str type: (Updatable) The type of OpenID. The allowed values are:
691
- * `IDCS_SECRET`: The OpenID configuration used is OpenSearch is IDCS.
692
- * `BASIC_AUTH_SECRET`: Basic authentication use for OpenSearch
693
- :param str vault_secret_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
694
- :param str client_id: (Updatable) The IDCS Connect clientId.
695
- :param str idcs_url: (Updatable) The URL represent authentication url of the IDCS.
696
- :param str scope_url: (Updatable) Fully qualified scope url
447
+ The Object Storage namespace.
697
448
  """
698
- pulumi.set(__self__, "type", type)
699
- pulumi.set(__self__, "vault_secret_id", vault_secret_id)
700
- if client_id is not None:
701
- pulumi.set(__self__, "client_id", client_id)
702
- if idcs_url is not None:
703
- pulumi.set(__self__, "idcs_url", idcs_url)
704
- if scope_url is not None:
705
- pulumi.set(__self__, "scope_url", scope_url)
449
+ return pulumi.get(self, "namespace")
706
450
 
707
451
  @property
708
452
  @pulumi.getter
709
- def type(self) -> str:
710
- """
711
- (Updatable) The type of OpenID. The allowed values are:
712
- * `IDCS_SECRET`: The OpenID configuration used is OpenSearch is IDCS.
713
- * `BASIC_AUTH_SECRET`: Basic authentication use for OpenSearch
714
- """
715
- return pulumi.get(self, "type")
716
-
717
- @property
718
- @pulumi.getter(name="vaultSecretId")
719
- def vault_secret_id(self) -> str:
720
- """
721
- (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
722
- """
723
- return pulumi.get(self, "vault_secret_id")
724
-
725
- @property
726
- @pulumi.getter(name="clientId")
727
- def client_id(self) -> Optional[str]:
728
- """
729
- (Updatable) The IDCS Connect clientId.
730
- """
731
- return pulumi.get(self, "client_id")
732
-
733
- @property
734
- @pulumi.getter(name="idcsUrl")
735
- def idcs_url(self) -> Optional[str]:
736
- """
737
- (Updatable) The URL represent authentication url of the IDCS.
738
- """
739
- return pulumi.get(self, "idcs_url")
740
-
741
- @property
742
- @pulumi.getter(name="scopeUrl")
743
- def scope_url(self) -> Optional[str]:
453
+ def object(self) -> str:
744
454
  """
745
- (Updatable) Fully qualified scope url
455
+ The Object Storage object name.
746
456
  """
747
- return pulumi.get(self, "scope_url")
457
+ return pulumi.get(self, "object")
748
458
 
749
459
 
750
460
  @pulumi.output_type
751
- class DedicatedAiClusterCapacity(dict):
461
+ class ModelModelMetric(dict):
752
462
  @staticmethod
753
463
  def __key_warning(key: str):
754
464
  suggest = None
755
- if key == "capacityType":
756
- suggest = "capacity_type"
757
- elif key == "totalEndpointCapacity":
758
- suggest = "total_endpoint_capacity"
759
- elif key == "usedEndpointCapacity":
760
- suggest = "used_endpoint_capacity"
465
+ if key == "finalAccuracy":
466
+ suggest = "final_accuracy"
467
+ elif key == "finalLoss":
468
+ suggest = "final_loss"
469
+ elif key == "modelMetricsType":
470
+ suggest = "model_metrics_type"
761
471
 
762
472
  if suggest:
763
- pulumi.log.warn(f"Key '{key}' not found in DedicatedAiClusterCapacity. Access the value via the '{suggest}' property getter instead.")
473
+ pulumi.log.warn(f"Key '{key}' not found in ModelModelMetric. Access the value via the '{suggest}' property getter instead.")
764
474
 
765
475
  def __getitem__(self, key: str) -> Any:
766
- DedicatedAiClusterCapacity.__key_warning(key)
476
+ ModelModelMetric.__key_warning(key)
767
477
  return super().__getitem__(key)
768
478
 
769
479
  def get(self, key: str, default = None) -> Any:
770
- DedicatedAiClusterCapacity.__key_warning(key)
480
+ ModelModelMetric.__key_warning(key)
771
481
  return super().get(key, default)
772
482
 
773
483
  def __init__(__self__, *,
774
- capacity_type: Optional[str] = None,
775
- total_endpoint_capacity: Optional[int] = None,
776
- used_endpoint_capacity: Optional[int] = None):
777
- """
778
- :param str capacity_type: The type of the dedicated AI cluster capacity.
779
- :param int total_endpoint_capacity: The total number of endpoints that can be hosted on this dedicated AI cluster.
780
- :param int used_endpoint_capacity: The number of endpoints hosted on this dedicated AI cluster.
781
- """
782
- if capacity_type is not None:
783
- pulumi.set(__self__, "capacity_type", capacity_type)
784
- if total_endpoint_capacity is not None:
785
- pulumi.set(__self__, "total_endpoint_capacity", total_endpoint_capacity)
786
- if used_endpoint_capacity is not None:
787
- pulumi.set(__self__, "used_endpoint_capacity", used_endpoint_capacity)
788
-
789
- @property
790
- @pulumi.getter(name="capacityType")
791
- def capacity_type(self) -> Optional[str]:
484
+ final_accuracy: Optional[float] = None,
485
+ final_loss: Optional[float] = None,
486
+ model_metrics_type: Optional[str] = None):
792
487
  """
793
- The type of the dedicated AI cluster capacity.
488
+ :param float final_accuracy: Fine-tuned model accuracy.
489
+ :param float final_loss: Fine-tuned model loss.
490
+ :param str model_metrics_type: The type of the model metrics. Each type of model can expect a different set of model metrics.
794
491
  """
795
- return pulumi.get(self, "capacity_type")
492
+ if final_accuracy is not None:
493
+ pulumi.set(__self__, "final_accuracy", final_accuracy)
494
+ if final_loss is not None:
495
+ pulumi.set(__self__, "final_loss", final_loss)
496
+ if model_metrics_type is not None:
497
+ pulumi.set(__self__, "model_metrics_type", model_metrics_type)
796
498
 
797
499
  @property
798
- @pulumi.getter(name="totalEndpointCapacity")
799
- def total_endpoint_capacity(self) -> Optional[int]:
500
+ @pulumi.getter(name="finalAccuracy")
501
+ def final_accuracy(self) -> Optional[float]:
800
502
  """
801
- The total number of endpoints that can be hosted on this dedicated AI cluster.
503
+ Fine-tuned model accuracy.
802
504
  """
803
- return pulumi.get(self, "total_endpoint_capacity")
505
+ return pulumi.get(self, "final_accuracy")
804
506
 
805
507
  @property
806
- @pulumi.getter(name="usedEndpointCapacity")
807
- def used_endpoint_capacity(self) -> Optional[int]:
808
- """
809
- The number of endpoints hosted on this dedicated AI cluster.
810
- """
811
- return pulumi.get(self, "used_endpoint_capacity")
812
-
813
-
814
- @pulumi.output_type
815
- class EndpointContentModerationConfig(dict):
816
- @staticmethod
817
- def __key_warning(key: str):
818
- suggest = None
819
- if key == "isEnabled":
820
- suggest = "is_enabled"
821
-
822
- if suggest:
823
- pulumi.log.warn(f"Key '{key}' not found in EndpointContentModerationConfig. Access the value via the '{suggest}' property getter instead.")
824
-
825
- def __getitem__(self, key: str) -> Any:
826
- EndpointContentModerationConfig.__key_warning(key)
827
- return super().__getitem__(key)
828
-
829
- def get(self, key: str, default = None) -> Any:
830
- EndpointContentModerationConfig.__key_warning(key)
831
- return super().get(key, default)
832
-
833
- def __init__(__self__, *,
834
- is_enabled: bool):
508
+ @pulumi.getter(name="finalLoss")
509
+ def final_loss(self) -> Optional[float]:
835
510
  """
836
- :param bool is_enabled: (Updatable) Whether to enable the content moderation feature.
511
+ Fine-tuned model loss.
837
512
  """
838
- pulumi.set(__self__, "is_enabled", is_enabled)
513
+ return pulumi.get(self, "final_loss")
839
514
 
840
515
  @property
841
- @pulumi.getter(name="isEnabled")
842
- def is_enabled(self) -> bool:
843
- """
844
- (Updatable) Whether to enable the content moderation feature.
516
+ @pulumi.getter(name="modelMetricsType")
517
+ def model_metrics_type(self) -> Optional[str]:
845
518
  """
846
- return pulumi.get(self, "is_enabled")
847
-
848
-
849
- @pulumi.output_type
850
- class ModelFineTuneDetails(dict):
851
- @staticmethod
852
- def __key_warning(key: str):
853
- suggest = None
854
- if key == "dedicatedAiClusterId":
855
- suggest = "dedicated_ai_cluster_id"
856
- elif key == "trainingDataset":
857
- suggest = "training_dataset"
858
- elif key == "trainingConfig":
859
- suggest = "training_config"
860
-
861
- if suggest:
862
- pulumi.log.warn(f"Key '{key}' not found in ModelFineTuneDetails. Access the value via the '{suggest}' property getter instead.")
863
-
864
- def __getitem__(self, key: str) -> Any:
865
- ModelFineTuneDetails.__key_warning(key)
866
- return super().__getitem__(key)
867
-
868
- def get(self, key: str, default = None) -> Any:
869
- ModelFineTuneDetails.__key_warning(key)
870
- return super().get(key, default)
871
-
872
- def __init__(__self__, *,
873
- dedicated_ai_cluster_id: str,
874
- training_dataset: 'outputs.ModelFineTuneDetailsTrainingDataset',
875
- training_config: Optional['outputs.ModelFineTuneDetailsTrainingConfig'] = None):
519
+ The type of the model metrics. Each type of model can expect a different set of model metrics.
876
520
  """
877
- :param str dedicated_ai_cluster_id: The OCID of the dedicated AI cluster this fine-tuning runs on.
878
- :param 'ModelFineTuneDetailsTrainingDatasetArgs' training_dataset: The dataset used to fine-tune the model.
879
-
880
- Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format: `{"prompt": "<first prompt>", "completion": "<expected completion given first prompt>"}`
881
- :param 'ModelFineTuneDetailsTrainingConfigArgs' training_config: The fine-tuning method and hyperparameters used for fine-tuning a custom model.
882
- """
883
- pulumi.set(__self__, "dedicated_ai_cluster_id", dedicated_ai_cluster_id)
884
- pulumi.set(__self__, "training_dataset", training_dataset)
885
- if training_config is not None:
886
- pulumi.set(__self__, "training_config", training_config)
887
-
888
- @property
889
- @pulumi.getter(name="dedicatedAiClusterId")
890
- def dedicated_ai_cluster_id(self) -> str:
891
- """
892
- The OCID of the dedicated AI cluster this fine-tuning runs on.
893
- """
894
- return pulumi.get(self, "dedicated_ai_cluster_id")
895
-
896
- @property
897
- @pulumi.getter(name="trainingDataset")
898
- def training_dataset(self) -> 'outputs.ModelFineTuneDetailsTrainingDataset':
899
- """
900
- The dataset used to fine-tune the model.
901
-
902
- Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format: `{"prompt": "<first prompt>", "completion": "<expected completion given first prompt>"}`
903
- """
904
- return pulumi.get(self, "training_dataset")
905
-
906
- @property
907
- @pulumi.getter(name="trainingConfig")
908
- def training_config(self) -> Optional['outputs.ModelFineTuneDetailsTrainingConfig']:
909
- """
910
- The fine-tuning method and hyperparameters used for fine-tuning a custom model.
911
- """
912
- return pulumi.get(self, "training_config")
913
-
914
-
915
- @pulumi.output_type
916
- class ModelFineTuneDetailsTrainingConfig(dict):
917
- @staticmethod
918
- def __key_warning(key: str):
919
- suggest = None
920
- if key == "trainingConfigType":
921
- suggest = "training_config_type"
922
- elif key == "earlyStoppingPatience":
923
- suggest = "early_stopping_patience"
924
- elif key == "earlyStoppingThreshold":
925
- suggest = "early_stopping_threshold"
926
- elif key == "learningRate":
927
- suggest = "learning_rate"
928
- elif key == "logModelMetricsIntervalInSteps":
929
- suggest = "log_model_metrics_interval_in_steps"
930
- elif key == "loraAlpha":
931
- suggest = "lora_alpha"
932
- elif key == "loraDropout":
933
- suggest = "lora_dropout"
934
- elif key == "loraR":
935
- suggest = "lora_r"
936
- elif key == "numOfLastLayers":
937
- suggest = "num_of_last_layers"
938
- elif key == "totalTrainingEpochs":
939
- suggest = "total_training_epochs"
940
- elif key == "trainingBatchSize":
941
- suggest = "training_batch_size"
942
-
943
- if suggest:
944
- pulumi.log.warn(f"Key '{key}' not found in ModelFineTuneDetailsTrainingConfig. Access the value via the '{suggest}' property getter instead.")
945
-
946
- def __getitem__(self, key: str) -> Any:
947
- ModelFineTuneDetailsTrainingConfig.__key_warning(key)
948
- return super().__getitem__(key)
949
-
950
- def get(self, key: str, default = None) -> Any:
951
- ModelFineTuneDetailsTrainingConfig.__key_warning(key)
952
- return super().get(key, default)
953
-
954
- def __init__(__self__, *,
955
- training_config_type: str,
956
- early_stopping_patience: Optional[int] = None,
957
- early_stopping_threshold: Optional[float] = None,
958
- learning_rate: Optional[float] = None,
959
- log_model_metrics_interval_in_steps: Optional[int] = None,
960
- lora_alpha: Optional[int] = None,
961
- lora_dropout: Optional[float] = None,
962
- lora_r: Optional[int] = None,
963
- num_of_last_layers: Optional[int] = None,
964
- total_training_epochs: Optional[int] = None,
965
- training_batch_size: Optional[int] = None):
966
- """
967
- :param str training_config_type: The fine-tuning method for training a custom model.
968
- :param int early_stopping_patience: Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
969
- :param float early_stopping_threshold: How much the loss must improve to prevent early stopping.
970
- :param float learning_rate: The initial learning rate to be used during training
971
- :param int log_model_metrics_interval_in_steps: Determines how frequently to log model metrics.
972
-
973
- Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
974
- :param int lora_alpha: This parameter represents the scaling factor for the weight matrices in LoRA.
975
- :param float lora_dropout: This parameter indicates the dropout probability for LoRA layers.
976
- :param int lora_r: This parameter represents the LoRA rank of the update matrices.
977
- :param int num_of_last_layers: The number of last layers to be fine-tuned.
978
- :param int total_training_epochs: The maximum number of training epochs to run for.
979
- :param int training_batch_size: The batch size used during training.
980
- """
981
- pulumi.set(__self__, "training_config_type", training_config_type)
982
- if early_stopping_patience is not None:
983
- pulumi.set(__self__, "early_stopping_patience", early_stopping_patience)
984
- if early_stopping_threshold is not None:
985
- pulumi.set(__self__, "early_stopping_threshold", early_stopping_threshold)
986
- if learning_rate is not None:
987
- pulumi.set(__self__, "learning_rate", learning_rate)
988
- if log_model_metrics_interval_in_steps is not None:
989
- pulumi.set(__self__, "log_model_metrics_interval_in_steps", log_model_metrics_interval_in_steps)
990
- if lora_alpha is not None:
991
- pulumi.set(__self__, "lora_alpha", lora_alpha)
992
- if lora_dropout is not None:
993
- pulumi.set(__self__, "lora_dropout", lora_dropout)
994
- if lora_r is not None:
995
- pulumi.set(__self__, "lora_r", lora_r)
996
- if num_of_last_layers is not None:
997
- pulumi.set(__self__, "num_of_last_layers", num_of_last_layers)
998
- if total_training_epochs is not None:
999
- pulumi.set(__self__, "total_training_epochs", total_training_epochs)
1000
- if training_batch_size is not None:
1001
- pulumi.set(__self__, "training_batch_size", training_batch_size)
1002
-
1003
- @property
1004
- @pulumi.getter(name="trainingConfigType")
1005
- def training_config_type(self) -> str:
1006
- """
1007
- The fine-tuning method for training a custom model.
1008
- """
1009
- return pulumi.get(self, "training_config_type")
1010
-
1011
- @property
1012
- @pulumi.getter(name="earlyStoppingPatience")
1013
- def early_stopping_patience(self) -> Optional[int]:
1014
- """
1015
- Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation.
1016
- """
1017
- return pulumi.get(self, "early_stopping_patience")
1018
-
1019
- @property
1020
- @pulumi.getter(name="earlyStoppingThreshold")
1021
- def early_stopping_threshold(self) -> Optional[float]:
1022
- """
1023
- How much the loss must improve to prevent early stopping.
1024
- """
1025
- return pulumi.get(self, "early_stopping_threshold")
1026
-
1027
- @property
1028
- @pulumi.getter(name="learningRate")
1029
- def learning_rate(self) -> Optional[float]:
1030
- """
1031
- The initial learning rate to be used during training
1032
- """
1033
- return pulumi.get(self, "learning_rate")
1034
-
1035
- @property
1036
- @pulumi.getter(name="logModelMetricsIntervalInSteps")
1037
- def log_model_metrics_interval_in_steps(self) -> Optional[int]:
1038
- """
1039
- Determines how frequently to log model metrics.
1040
-
1041
- Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics.
1042
- """
1043
- return pulumi.get(self, "log_model_metrics_interval_in_steps")
1044
-
1045
- @property
1046
- @pulumi.getter(name="loraAlpha")
1047
- def lora_alpha(self) -> Optional[int]:
1048
- """
1049
- This parameter represents the scaling factor for the weight matrices in LoRA.
1050
- """
1051
- return pulumi.get(self, "lora_alpha")
1052
-
1053
- @property
1054
- @pulumi.getter(name="loraDropout")
1055
- def lora_dropout(self) -> Optional[float]:
1056
- """
1057
- This parameter indicates the dropout probability for LoRA layers.
1058
- """
1059
- return pulumi.get(self, "lora_dropout")
1060
-
1061
- @property
1062
- @pulumi.getter(name="loraR")
1063
- def lora_r(self) -> Optional[int]:
1064
- """
1065
- This parameter represents the LoRA rank of the update matrices.
1066
- """
1067
- return pulumi.get(self, "lora_r")
1068
-
1069
- @property
1070
- @pulumi.getter(name="numOfLastLayers")
1071
- def num_of_last_layers(self) -> Optional[int]:
1072
- """
1073
- The number of last layers to be fine-tuned.
1074
- """
1075
- return pulumi.get(self, "num_of_last_layers")
1076
-
1077
- @property
1078
- @pulumi.getter(name="totalTrainingEpochs")
1079
- def total_training_epochs(self) -> Optional[int]:
1080
- """
1081
- The maximum number of training epochs to run for.
1082
- """
1083
- return pulumi.get(self, "total_training_epochs")
1084
-
1085
- @property
1086
- @pulumi.getter(name="trainingBatchSize")
1087
- def training_batch_size(self) -> Optional[int]:
1088
- """
1089
- The batch size used during training.
1090
- """
1091
- return pulumi.get(self, "training_batch_size")
1092
-
1093
-
1094
- @pulumi.output_type
1095
- class ModelFineTuneDetailsTrainingDataset(dict):
1096
- @staticmethod
1097
- def __key_warning(key: str):
1098
- suggest = None
1099
- if key == "datasetType":
1100
- suggest = "dataset_type"
1101
-
1102
- if suggest:
1103
- pulumi.log.warn(f"Key '{key}' not found in ModelFineTuneDetailsTrainingDataset. Access the value via the '{suggest}' property getter instead.")
1104
-
1105
- def __getitem__(self, key: str) -> Any:
1106
- ModelFineTuneDetailsTrainingDataset.__key_warning(key)
1107
- return super().__getitem__(key)
1108
-
1109
- def get(self, key: str, default = None) -> Any:
1110
- ModelFineTuneDetailsTrainingDataset.__key_warning(key)
1111
- return super().get(key, default)
1112
-
1113
- def __init__(__self__, *,
1114
- bucket: str,
1115
- dataset_type: str,
1116
- namespace: str,
1117
- object: str):
1118
- """
1119
- :param str bucket: The Object Storage bucket name.
1120
- :param str dataset_type: The type of the data asset.
1121
- :param str namespace: The Object Storage namespace.
1122
- :param str object: The Object Storage object name.
1123
- """
1124
- pulumi.set(__self__, "bucket", bucket)
1125
- pulumi.set(__self__, "dataset_type", dataset_type)
1126
- pulumi.set(__self__, "namespace", namespace)
1127
- pulumi.set(__self__, "object", object)
1128
-
1129
- @property
1130
- @pulumi.getter
1131
- def bucket(self) -> str:
1132
- """
1133
- The Object Storage bucket name.
1134
- """
1135
- return pulumi.get(self, "bucket")
1136
-
1137
- @property
1138
- @pulumi.getter(name="datasetType")
1139
- def dataset_type(self) -> str:
1140
- """
1141
- The type of the data asset.
1142
- """
1143
- return pulumi.get(self, "dataset_type")
1144
-
1145
- @property
1146
- @pulumi.getter
1147
- def namespace(self) -> str:
1148
- """
1149
- The Object Storage namespace.
1150
- """
1151
- return pulumi.get(self, "namespace")
1152
-
1153
- @property
1154
- @pulumi.getter
1155
- def object(self) -> str:
1156
- """
1157
- The Object Storage object name.
1158
- """
1159
- return pulumi.get(self, "object")
1160
-
1161
-
1162
- @pulumi.output_type
1163
- class ModelModelMetric(dict):
1164
- @staticmethod
1165
- def __key_warning(key: str):
1166
- suggest = None
1167
- if key == "finalAccuracy":
1168
- suggest = "final_accuracy"
1169
- elif key == "finalLoss":
1170
- suggest = "final_loss"
1171
- elif key == "modelMetricsType":
1172
- suggest = "model_metrics_type"
1173
-
1174
- if suggest:
1175
- pulumi.log.warn(f"Key '{key}' not found in ModelModelMetric. Access the value via the '{suggest}' property getter instead.")
1176
-
1177
- def __getitem__(self, key: str) -> Any:
1178
- ModelModelMetric.__key_warning(key)
1179
- return super().__getitem__(key)
1180
-
1181
- def get(self, key: str, default = None) -> Any:
1182
- ModelModelMetric.__key_warning(key)
1183
- return super().get(key, default)
1184
-
1185
- def __init__(__self__, *,
1186
- final_accuracy: Optional[float] = None,
1187
- final_loss: Optional[float] = None,
1188
- model_metrics_type: Optional[str] = None):
1189
- """
1190
- :param float final_accuracy: Fine-tuned model accuracy.
1191
- :param float final_loss: Fine-tuned model loss.
1192
- :param str model_metrics_type: The type of the model metrics. Each type of model can expect a different set of model metrics.
1193
- """
1194
- if final_accuracy is not None:
1195
- pulumi.set(__self__, "final_accuracy", final_accuracy)
1196
- if final_loss is not None:
1197
- pulumi.set(__self__, "final_loss", final_loss)
1198
- if model_metrics_type is not None:
1199
- pulumi.set(__self__, "model_metrics_type", model_metrics_type)
1200
-
1201
- @property
1202
- @pulumi.getter(name="finalAccuracy")
1203
- def final_accuracy(self) -> Optional[float]:
1204
- """
1205
- Fine-tuned model accuracy.
1206
- """
1207
- return pulumi.get(self, "final_accuracy")
1208
-
1209
- @property
1210
- @pulumi.getter(name="finalLoss")
1211
- def final_loss(self) -> Optional[float]:
1212
- """
1213
- Fine-tuned model loss.
1214
- """
1215
- return pulumi.get(self, "final_loss")
1216
-
1217
- @property
1218
- @pulumi.getter(name="modelMetricsType")
1219
- def model_metrics_type(self) -> Optional[str]:
1220
- """
1221
- The type of the model metrics. Each type of model can expect a different set of model metrics.
1222
- """
1223
- return pulumi.get(self, "model_metrics_type")
1224
-
1225
-
1226
- @pulumi.output_type
1227
- class GetAgentAgentEndpointContentModerationConfigResult(dict):
1228
- def __init__(__self__, *,
1229
- should_enable_on_input: bool,
1230
- should_enable_on_output: bool):
1231
- """
1232
- :param bool should_enable_on_input: A flag to enable or disable content moderation on input.
1233
- :param bool should_enable_on_output: A flag to enable or disable content moderation on output.
1234
- """
1235
- pulumi.set(__self__, "should_enable_on_input", should_enable_on_input)
1236
- pulumi.set(__self__, "should_enable_on_output", should_enable_on_output)
1237
-
1238
- @property
1239
- @pulumi.getter(name="shouldEnableOnInput")
1240
- def should_enable_on_input(self) -> bool:
1241
- """
1242
- A flag to enable or disable content moderation on input.
1243
- """
1244
- return pulumi.get(self, "should_enable_on_input")
1245
-
1246
- @property
1247
- @pulumi.getter(name="shouldEnableOnOutput")
1248
- def should_enable_on_output(self) -> bool:
1249
- """
1250
- A flag to enable or disable content moderation on output.
1251
- """
1252
- return pulumi.get(self, "should_enable_on_output")
1253
-
1254
-
1255
- @pulumi.output_type
1256
- class GetAgentAgentEndpointSessionConfigResult(dict):
1257
- def __init__(__self__, *,
1258
- idle_timeout_in_seconds: int):
1259
- """
1260
- :param int idle_timeout_in_seconds: The session will become inactive after this timeout.
1261
- """
1262
- pulumi.set(__self__, "idle_timeout_in_seconds", idle_timeout_in_seconds)
1263
-
1264
- @property
1265
- @pulumi.getter(name="idleTimeoutInSeconds")
1266
- def idle_timeout_in_seconds(self) -> int:
1267
- """
1268
- The session will become inactive after this timeout.
1269
- """
1270
- return pulumi.get(self, "idle_timeout_in_seconds")
1271
-
1272
-
1273
- @pulumi.output_type
1274
- class GetAgentAgentEndpointsAgentEndpointCollectionResult(dict):
1275
- def __init__(__self__, *,
1276
- items: Sequence['outputs.GetAgentAgentEndpointsAgentEndpointCollectionItemResult']):
1277
- pulumi.set(__self__, "items", items)
1278
-
1279
- @property
1280
- @pulumi.getter
1281
- def items(self) -> Sequence['outputs.GetAgentAgentEndpointsAgentEndpointCollectionItemResult']:
1282
- return pulumi.get(self, "items")
1283
-
1284
-
1285
- @pulumi.output_type
1286
- class GetAgentAgentEndpointsAgentEndpointCollectionItemResult(dict):
1287
- def __init__(__self__, *,
1288
- agent_id: str,
1289
- compartment_id: str,
1290
- content_moderation_configs: Sequence['outputs.GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfigResult'],
1291
- defined_tags: Mapping[str, str],
1292
- description: str,
1293
- display_name: str,
1294
- freeform_tags: Mapping[str, str],
1295
- id: str,
1296
- lifecycle_details: str,
1297
- session_configs: Sequence['outputs.GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfigResult'],
1298
- should_enable_citation: bool,
1299
- should_enable_session: bool,
1300
- should_enable_trace: bool,
1301
- state: str,
1302
- system_tags: Mapping[str, str],
1303
- time_created: str,
1304
- time_updated: str):
1305
- """
1306
- :param str agent_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
1307
- :param str compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
1308
- :param Sequence['GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfigArgs'] content_moderation_configs: The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
1309
- :param Mapping[str, str] defined_tags: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
1310
- :param str description: An optional description of the endpoint.
1311
- :param str display_name: A filter to return only resources that match the given display name exactly.
1312
- :param Mapping[str, str] freeform_tags: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
1313
- :param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
1314
- :param str lifecycle_details: A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
1315
- :param Sequence['GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfigArgs'] session_configs: **SessionConfig**
1316
- :param bool should_enable_citation: Whether to show citations in the chat result.
1317
- :param bool should_enable_session: Whether or not to enable Session-based chat.
1318
- :param bool should_enable_trace: Whether to show traces in the chat result.
1319
- :param str state: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
1320
- :param Mapping[str, str] system_tags: System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
1321
- :param str time_created: The date and time the AgentEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1322
- :param str time_updated: The date and time the endpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1323
- """
1324
- pulumi.set(__self__, "agent_id", agent_id)
1325
- pulumi.set(__self__, "compartment_id", compartment_id)
1326
- pulumi.set(__self__, "content_moderation_configs", content_moderation_configs)
1327
- pulumi.set(__self__, "defined_tags", defined_tags)
1328
- pulumi.set(__self__, "description", description)
1329
- pulumi.set(__self__, "display_name", display_name)
1330
- pulumi.set(__self__, "freeform_tags", freeform_tags)
1331
- pulumi.set(__self__, "id", id)
1332
- pulumi.set(__self__, "lifecycle_details", lifecycle_details)
1333
- pulumi.set(__self__, "session_configs", session_configs)
1334
- pulumi.set(__self__, "should_enable_citation", should_enable_citation)
1335
- pulumi.set(__self__, "should_enable_session", should_enable_session)
1336
- pulumi.set(__self__, "should_enable_trace", should_enable_trace)
1337
- pulumi.set(__self__, "state", state)
1338
- pulumi.set(__self__, "system_tags", system_tags)
1339
- pulumi.set(__self__, "time_created", time_created)
1340
- pulumi.set(__self__, "time_updated", time_updated)
1341
-
1342
- @property
1343
- @pulumi.getter(name="agentId")
1344
- def agent_id(self) -> str:
1345
- """
1346
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
1347
- """
1348
- return pulumi.get(self, "agent_id")
1349
-
1350
- @property
1351
- @pulumi.getter(name="compartmentId")
1352
- def compartment_id(self) -> str:
1353
- """
1354
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
1355
- """
1356
- return pulumi.get(self, "compartment_id")
1357
-
1358
- @property
1359
- @pulumi.getter(name="contentModerationConfigs")
1360
- def content_moderation_configs(self) -> Sequence['outputs.GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfigResult']:
1361
- """
1362
- The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
1363
- """
1364
- return pulumi.get(self, "content_moderation_configs")
1365
-
1366
- @property
1367
- @pulumi.getter(name="definedTags")
1368
- def defined_tags(self) -> Mapping[str, str]:
1369
- """
1370
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
1371
- """
1372
- return pulumi.get(self, "defined_tags")
1373
-
1374
- @property
1375
- @pulumi.getter
1376
- def description(self) -> str:
1377
- """
1378
- An optional description of the endpoint.
1379
- """
1380
- return pulumi.get(self, "description")
1381
-
1382
- @property
1383
- @pulumi.getter(name="displayName")
1384
- def display_name(self) -> str:
1385
- """
1386
- A filter to return only resources that match the given display name exactly.
1387
- """
1388
- return pulumi.get(self, "display_name")
1389
-
1390
- @property
1391
- @pulumi.getter(name="freeformTags")
1392
- def freeform_tags(self) -> Mapping[str, str]:
1393
- """
1394
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
1395
- """
1396
- return pulumi.get(self, "freeform_tags")
1397
-
1398
- @property
1399
- @pulumi.getter
1400
- def id(self) -> str:
1401
- """
1402
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
1403
- """
1404
- return pulumi.get(self, "id")
1405
-
1406
- @property
1407
- @pulumi.getter(name="lifecycleDetails")
1408
- def lifecycle_details(self) -> str:
1409
- """
1410
- A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
1411
- """
1412
- return pulumi.get(self, "lifecycle_details")
1413
-
1414
- @property
1415
- @pulumi.getter(name="sessionConfigs")
1416
- def session_configs(self) -> Sequence['outputs.GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfigResult']:
1417
- """
1418
- **SessionConfig**
1419
- """
1420
- return pulumi.get(self, "session_configs")
1421
-
1422
- @property
1423
- @pulumi.getter(name="shouldEnableCitation")
1424
- def should_enable_citation(self) -> bool:
1425
- """
1426
- Whether to show citations in the chat result.
1427
- """
1428
- return pulumi.get(self, "should_enable_citation")
1429
-
1430
- @property
1431
- @pulumi.getter(name="shouldEnableSession")
1432
- def should_enable_session(self) -> bool:
1433
- """
1434
- Whether or not to enable Session-based chat.
1435
- """
1436
- return pulumi.get(self, "should_enable_session")
1437
-
1438
- @property
1439
- @pulumi.getter(name="shouldEnableTrace")
1440
- def should_enable_trace(self) -> bool:
1441
- """
1442
- Whether to show traces in the chat result.
1443
- """
1444
- return pulumi.get(self, "should_enable_trace")
1445
-
1446
- @property
1447
- @pulumi.getter
1448
- def state(self) -> str:
1449
- """
1450
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
1451
- """
1452
- return pulumi.get(self, "state")
1453
-
1454
- @property
1455
- @pulumi.getter(name="systemTags")
1456
- def system_tags(self) -> Mapping[str, str]:
1457
- """
1458
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
1459
- """
1460
- return pulumi.get(self, "system_tags")
1461
-
1462
- @property
1463
- @pulumi.getter(name="timeCreated")
1464
- def time_created(self) -> str:
1465
- """
1466
- The date and time the AgentEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1467
- """
1468
- return pulumi.get(self, "time_created")
1469
-
1470
- @property
1471
- @pulumi.getter(name="timeUpdated")
1472
- def time_updated(self) -> str:
1473
- """
1474
- The date and time the endpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1475
- """
1476
- return pulumi.get(self, "time_updated")
1477
-
1478
-
1479
- @pulumi.output_type
1480
- class GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfigResult(dict):
1481
- def __init__(__self__, *,
1482
- should_enable_on_input: bool,
1483
- should_enable_on_output: bool):
1484
- """
1485
- :param bool should_enable_on_input: A flag to enable or disable content moderation on input.
1486
- :param bool should_enable_on_output: A flag to enable or disable content moderation on output.
1487
- """
1488
- pulumi.set(__self__, "should_enable_on_input", should_enable_on_input)
1489
- pulumi.set(__self__, "should_enable_on_output", should_enable_on_output)
1490
-
1491
- @property
1492
- @pulumi.getter(name="shouldEnableOnInput")
1493
- def should_enable_on_input(self) -> bool:
1494
- """
1495
- A flag to enable or disable content moderation on input.
1496
- """
1497
- return pulumi.get(self, "should_enable_on_input")
1498
-
1499
- @property
1500
- @pulumi.getter(name="shouldEnableOnOutput")
1501
- def should_enable_on_output(self) -> bool:
1502
- """
1503
- A flag to enable or disable content moderation on output.
1504
- """
1505
- return pulumi.get(self, "should_enable_on_output")
1506
-
1507
-
1508
- @pulumi.output_type
1509
- class GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfigResult(dict):
1510
- def __init__(__self__, *,
1511
- idle_timeout_in_seconds: int):
1512
- """
1513
- :param int idle_timeout_in_seconds: The session will become inactive after this timeout.
1514
- """
1515
- pulumi.set(__self__, "idle_timeout_in_seconds", idle_timeout_in_seconds)
1516
-
1517
- @property
1518
- @pulumi.getter(name="idleTimeoutInSeconds")
1519
- def idle_timeout_in_seconds(self) -> int:
1520
- """
1521
- The session will become inactive after this timeout.
1522
- """
1523
- return pulumi.get(self, "idle_timeout_in_seconds")
1524
-
1525
-
1526
- @pulumi.output_type
1527
- class GetAgentAgentEndpointsFilterResult(dict):
1528
- def __init__(__self__, *,
1529
- name: str,
1530
- values: Sequence[str],
1531
- regex: Optional[bool] = None):
1532
- pulumi.set(__self__, "name", name)
1533
- pulumi.set(__self__, "values", values)
1534
- if regex is not None:
1535
- pulumi.set(__self__, "regex", regex)
1536
-
1537
- @property
1538
- @pulumi.getter
1539
- def name(self) -> str:
1540
- return pulumi.get(self, "name")
1541
-
1542
- @property
1543
- @pulumi.getter
1544
- def values(self) -> Sequence[str]:
1545
- return pulumi.get(self, "values")
1546
-
1547
- @property
1548
- @pulumi.getter
1549
- def regex(self) -> Optional[bool]:
1550
- return pulumi.get(self, "regex")
1551
-
1552
-
1553
- @pulumi.output_type
1554
- class GetAgentAgentsAgentCollectionResult(dict):
1555
- def __init__(__self__, *,
1556
- items: Sequence['outputs.GetAgentAgentsAgentCollectionItemResult']):
1557
- pulumi.set(__self__, "items", items)
1558
-
1559
- @property
1560
- @pulumi.getter
1561
- def items(self) -> Sequence['outputs.GetAgentAgentsAgentCollectionItemResult']:
1562
- return pulumi.get(self, "items")
1563
-
1564
-
1565
- @pulumi.output_type
1566
- class GetAgentAgentsAgentCollectionItemResult(dict):
1567
- def __init__(__self__, *,
1568
- compartment_id: str,
1569
- defined_tags: Mapping[str, str],
1570
- description: str,
1571
- display_name: str,
1572
- freeform_tags: Mapping[str, str],
1573
- id: str,
1574
- knowledge_base_ids: Sequence[str],
1575
- lifecycle_details: str,
1576
- state: str,
1577
- system_tags: Mapping[str, str],
1578
- time_created: str,
1579
- time_updated: str,
1580
- welcome_message: str):
1581
- """
1582
- :param str compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
1583
- :param Mapping[str, str] defined_tags: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
1584
- :param str description: Description about the agent.
1585
- :param str display_name: A filter to return only resources that match the given display name exactly.
1586
- :param Mapping[str, str] freeform_tags: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
1587
- :param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
1588
- :param Sequence[str] knowledge_base_ids: List of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent.
1589
- :param str lifecycle_details: A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
1590
- :param str state: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
1591
- :param Mapping[str, str] system_tags: System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
1592
- :param str time_created: The date and time the agent was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1593
- :param str time_updated: The date and time the agent was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1594
- :param str welcome_message: Details about purpose and responsibility of the agent
1595
- """
1596
- pulumi.set(__self__, "compartment_id", compartment_id)
1597
- pulumi.set(__self__, "defined_tags", defined_tags)
1598
- pulumi.set(__self__, "description", description)
1599
- pulumi.set(__self__, "display_name", display_name)
1600
- pulumi.set(__self__, "freeform_tags", freeform_tags)
1601
- pulumi.set(__self__, "id", id)
1602
- pulumi.set(__self__, "knowledge_base_ids", knowledge_base_ids)
1603
- pulumi.set(__self__, "lifecycle_details", lifecycle_details)
1604
- pulumi.set(__self__, "state", state)
1605
- pulumi.set(__self__, "system_tags", system_tags)
1606
- pulumi.set(__self__, "time_created", time_created)
1607
- pulumi.set(__self__, "time_updated", time_updated)
1608
- pulumi.set(__self__, "welcome_message", welcome_message)
1609
-
1610
- @property
1611
- @pulumi.getter(name="compartmentId")
1612
- def compartment_id(self) -> str:
1613
- """
1614
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
1615
- """
1616
- return pulumi.get(self, "compartment_id")
1617
-
1618
- @property
1619
- @pulumi.getter(name="definedTags")
1620
- def defined_tags(self) -> Mapping[str, str]:
1621
- """
1622
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
1623
- """
1624
- return pulumi.get(self, "defined_tags")
1625
-
1626
- @property
1627
- @pulumi.getter
1628
- def description(self) -> str:
1629
- """
1630
- Description about the agent.
1631
- """
1632
- return pulumi.get(self, "description")
1633
-
1634
- @property
1635
- @pulumi.getter(name="displayName")
1636
- def display_name(self) -> str:
1637
- """
1638
- A filter to return only resources that match the given display name exactly.
1639
- """
1640
- return pulumi.get(self, "display_name")
1641
-
1642
- @property
1643
- @pulumi.getter(name="freeformTags")
1644
- def freeform_tags(self) -> Mapping[str, str]:
1645
- """
1646
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
1647
- """
1648
- return pulumi.get(self, "freeform_tags")
1649
-
1650
- @property
1651
- @pulumi.getter
1652
- def id(self) -> str:
1653
- """
1654
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent.
1655
- """
1656
- return pulumi.get(self, "id")
1657
-
1658
- @property
1659
- @pulumi.getter(name="knowledgeBaseIds")
1660
- def knowledge_base_ids(self) -> Sequence[str]:
1661
- """
1662
- List of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent.
1663
- """
1664
- return pulumi.get(self, "knowledge_base_ids")
1665
-
1666
- @property
1667
- @pulumi.getter(name="lifecycleDetails")
1668
- def lifecycle_details(self) -> str:
1669
- """
1670
- A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
1671
- """
1672
- return pulumi.get(self, "lifecycle_details")
1673
-
1674
- @property
1675
- @pulumi.getter
1676
- def state(self) -> str:
1677
- """
1678
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
1679
- """
1680
- return pulumi.get(self, "state")
1681
-
1682
- @property
1683
- @pulumi.getter(name="systemTags")
1684
- def system_tags(self) -> Mapping[str, str]:
1685
- """
1686
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
1687
- """
1688
- return pulumi.get(self, "system_tags")
1689
-
1690
- @property
1691
- @pulumi.getter(name="timeCreated")
1692
- def time_created(self) -> str:
1693
- """
1694
- The date and time the agent was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1695
- """
1696
- return pulumi.get(self, "time_created")
1697
-
1698
- @property
1699
- @pulumi.getter(name="timeUpdated")
1700
- def time_updated(self) -> str:
1701
- """
1702
- The date and time the agent was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1703
- """
1704
- return pulumi.get(self, "time_updated")
1705
-
1706
- @property
1707
- @pulumi.getter(name="welcomeMessage")
1708
- def welcome_message(self) -> str:
1709
- """
1710
- Details about purpose and responsibility of the agent
1711
- """
1712
- return pulumi.get(self, "welcome_message")
1713
-
1714
-
1715
- @pulumi.output_type
1716
- class GetAgentAgentsFilterResult(dict):
1717
- def __init__(__self__, *,
1718
- name: str,
1719
- values: Sequence[str],
1720
- regex: Optional[bool] = None):
1721
- pulumi.set(__self__, "name", name)
1722
- pulumi.set(__self__, "values", values)
1723
- if regex is not None:
1724
- pulumi.set(__self__, "regex", regex)
1725
-
1726
- @property
1727
- @pulumi.getter
1728
- def name(self) -> str:
1729
- return pulumi.get(self, "name")
1730
-
1731
- @property
1732
- @pulumi.getter
1733
- def values(self) -> Sequence[str]:
1734
- return pulumi.get(self, "values")
1735
-
1736
- @property
1737
- @pulumi.getter
1738
- def regex(self) -> Optional[bool]:
1739
- return pulumi.get(self, "regex")
1740
-
1741
-
1742
- @pulumi.output_type
1743
- class GetAgentDataIngestionJobDataIngestionJobStatisticResult(dict):
1744
- def __init__(__self__, *,
1745
- duration_in_seconds: int,
1746
- number_of_failed_files: int,
1747
- number_of_ingested_files: int):
1748
- """
1749
- :param int duration_in_seconds: The duration of this ingestion job.
1750
- :param int number_of_failed_files: The number of files that have failed during the ingestion.
1751
- :param int number_of_ingested_files: The number of files that have been successfully ingested during the ingestion.
1752
- """
1753
- pulumi.set(__self__, "duration_in_seconds", duration_in_seconds)
1754
- pulumi.set(__self__, "number_of_failed_files", number_of_failed_files)
1755
- pulumi.set(__self__, "number_of_ingested_files", number_of_ingested_files)
1756
-
1757
- @property
1758
- @pulumi.getter(name="durationInSeconds")
1759
- def duration_in_seconds(self) -> int:
1760
- """
1761
- The duration of this ingestion job.
1762
- """
1763
- return pulumi.get(self, "duration_in_seconds")
1764
-
1765
- @property
1766
- @pulumi.getter(name="numberOfFailedFiles")
1767
- def number_of_failed_files(self) -> int:
1768
- """
1769
- The number of files that have failed during the ingestion.
1770
- """
1771
- return pulumi.get(self, "number_of_failed_files")
1772
-
1773
- @property
1774
- @pulumi.getter(name="numberOfIngestedFiles")
1775
- def number_of_ingested_files(self) -> int:
1776
- """
1777
- The number of files that have been successfully ingested during the ingestion.
1778
- """
1779
- return pulumi.get(self, "number_of_ingested_files")
1780
-
1781
-
1782
- @pulumi.output_type
1783
- class GetAgentDataIngestionJobsDataIngestionJobCollectionResult(dict):
1784
- def __init__(__self__, *,
1785
- items: Sequence['outputs.GetAgentDataIngestionJobsDataIngestionJobCollectionItemResult']):
1786
- pulumi.set(__self__, "items", items)
1787
-
1788
- @property
1789
- @pulumi.getter
1790
- def items(self) -> Sequence['outputs.GetAgentDataIngestionJobsDataIngestionJobCollectionItemResult']:
1791
- return pulumi.get(self, "items")
1792
-
1793
-
1794
- @pulumi.output_type
1795
- class GetAgentDataIngestionJobsDataIngestionJobCollectionItemResult(dict):
1796
- def __init__(__self__, *,
1797
- compartment_id: str,
1798
- data_ingestion_job_statistics: Sequence['outputs.GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatisticResult'],
1799
- data_source_id: str,
1800
- defined_tags: Mapping[str, str],
1801
- description: str,
1802
- display_name: str,
1803
- freeform_tags: Mapping[str, str],
1804
- id: str,
1805
- lifecycle_details: str,
1806
- state: str,
1807
- system_tags: Mapping[str, str],
1808
- time_created: str,
1809
- time_updated: str):
1810
- """
1811
- :param str compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
1812
- :param Sequence['GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatisticArgs'] data_ingestion_job_statistics: **DataIngestionJobStatistics**
1813
- :param str data_source_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
1814
- :param Mapping[str, str] defined_tags: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
1815
- :param str description: A user-friendly name. Does not have to be unique, and it's changeable.
1816
- :param str display_name: A filter to return only resources that match the given display name exactly.
1817
- :param Mapping[str, str] freeform_tags: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
1818
- :param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DataIngestionJob.
1819
- :param str lifecycle_details: A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
1820
- :param str state: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
1821
- :param Mapping[str, str] system_tags: System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
1822
- :param str time_created: The date and time the data ingestion job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1823
- :param str time_updated: The date and time the data ingestion job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1824
- """
1825
- pulumi.set(__self__, "compartment_id", compartment_id)
1826
- pulumi.set(__self__, "data_ingestion_job_statistics", data_ingestion_job_statistics)
1827
- pulumi.set(__self__, "data_source_id", data_source_id)
1828
- pulumi.set(__self__, "defined_tags", defined_tags)
1829
- pulumi.set(__self__, "description", description)
1830
- pulumi.set(__self__, "display_name", display_name)
1831
- pulumi.set(__self__, "freeform_tags", freeform_tags)
1832
- pulumi.set(__self__, "id", id)
1833
- pulumi.set(__self__, "lifecycle_details", lifecycle_details)
1834
- pulumi.set(__self__, "state", state)
1835
- pulumi.set(__self__, "system_tags", system_tags)
1836
- pulumi.set(__self__, "time_created", time_created)
1837
- pulumi.set(__self__, "time_updated", time_updated)
1838
-
1839
- @property
1840
- @pulumi.getter(name="compartmentId")
1841
- def compartment_id(self) -> str:
1842
- """
1843
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
1844
- """
1845
- return pulumi.get(self, "compartment_id")
1846
-
1847
- @property
1848
- @pulumi.getter(name="dataIngestionJobStatistics")
1849
- def data_ingestion_job_statistics(self) -> Sequence['outputs.GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatisticResult']:
1850
- """
1851
- **DataIngestionJobStatistics**
1852
- """
1853
- return pulumi.get(self, "data_ingestion_job_statistics")
1854
-
1855
- @property
1856
- @pulumi.getter(name="dataSourceId")
1857
- def data_source_id(self) -> str:
1858
- """
1859
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
1860
- """
1861
- return pulumi.get(self, "data_source_id")
1862
-
1863
- @property
1864
- @pulumi.getter(name="definedTags")
1865
- def defined_tags(self) -> Mapping[str, str]:
1866
- """
1867
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
1868
- """
1869
- return pulumi.get(self, "defined_tags")
1870
-
1871
- @property
1872
- @pulumi.getter
1873
- def description(self) -> str:
1874
- """
1875
- A user-friendly name. Does not have to be unique, and it's changeable.
1876
- """
1877
- return pulumi.get(self, "description")
1878
-
1879
- @property
1880
- @pulumi.getter(name="displayName")
1881
- def display_name(self) -> str:
1882
- """
1883
- A filter to return only resources that match the given display name exactly.
1884
- """
1885
- return pulumi.get(self, "display_name")
1886
-
1887
- @property
1888
- @pulumi.getter(name="freeformTags")
1889
- def freeform_tags(self) -> Mapping[str, str]:
1890
- """
1891
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
1892
- """
1893
- return pulumi.get(self, "freeform_tags")
1894
-
1895
- @property
1896
- @pulumi.getter
1897
- def id(self) -> str:
1898
- """
1899
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DataIngestionJob.
1900
- """
1901
- return pulumi.get(self, "id")
1902
-
1903
- @property
1904
- @pulumi.getter(name="lifecycleDetails")
1905
- def lifecycle_details(self) -> str:
1906
- """
1907
- A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
1908
- """
1909
- return pulumi.get(self, "lifecycle_details")
1910
-
1911
- @property
1912
- @pulumi.getter
1913
- def state(self) -> str:
1914
- """
1915
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
1916
- """
1917
- return pulumi.get(self, "state")
1918
-
1919
- @property
1920
- @pulumi.getter(name="systemTags")
1921
- def system_tags(self) -> Mapping[str, str]:
1922
- """
1923
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
1924
- """
1925
- return pulumi.get(self, "system_tags")
1926
-
1927
- @property
1928
- @pulumi.getter(name="timeCreated")
1929
- def time_created(self) -> str:
1930
- """
1931
- The date and time the data ingestion job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1932
- """
1933
- return pulumi.get(self, "time_created")
1934
-
1935
- @property
1936
- @pulumi.getter(name="timeUpdated")
1937
- def time_updated(self) -> str:
1938
- """
1939
- The date and time the data ingestion job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
1940
- """
1941
- return pulumi.get(self, "time_updated")
1942
-
1943
-
1944
- @pulumi.output_type
1945
- class GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatisticResult(dict):
1946
- def __init__(__self__, *,
1947
- duration_in_seconds: int,
1948
- number_of_failed_files: int,
1949
- number_of_ingested_files: int):
1950
- """
1951
- :param int duration_in_seconds: The duration of this ingestion job.
1952
- :param int number_of_failed_files: The number of files that have failed during the ingestion.
1953
- :param int number_of_ingested_files: The number of files that have been successfully ingested during the ingestion.
1954
- """
1955
- pulumi.set(__self__, "duration_in_seconds", duration_in_seconds)
1956
- pulumi.set(__self__, "number_of_failed_files", number_of_failed_files)
1957
- pulumi.set(__self__, "number_of_ingested_files", number_of_ingested_files)
1958
-
1959
- @property
1960
- @pulumi.getter(name="durationInSeconds")
1961
- def duration_in_seconds(self) -> int:
1962
- """
1963
- The duration of this ingestion job.
1964
- """
1965
- return pulumi.get(self, "duration_in_seconds")
1966
-
1967
- @property
1968
- @pulumi.getter(name="numberOfFailedFiles")
1969
- def number_of_failed_files(self) -> int:
1970
- """
1971
- The number of files that have failed during the ingestion.
1972
- """
1973
- return pulumi.get(self, "number_of_failed_files")
1974
-
1975
- @property
1976
- @pulumi.getter(name="numberOfIngestedFiles")
1977
- def number_of_ingested_files(self) -> int:
1978
- """
1979
- The number of files that have been successfully ingested during the ingestion.
1980
- """
1981
- return pulumi.get(self, "number_of_ingested_files")
1982
-
1983
-
1984
- @pulumi.output_type
1985
- class GetAgentDataIngestionJobsFilterResult(dict):
1986
- def __init__(__self__, *,
1987
- name: str,
1988
- values: Sequence[str],
1989
- regex: Optional[bool] = None):
1990
- pulumi.set(__self__, "name", name)
1991
- pulumi.set(__self__, "values", values)
1992
- if regex is not None:
1993
- pulumi.set(__self__, "regex", regex)
1994
-
1995
- @property
1996
- @pulumi.getter
1997
- def name(self) -> str:
1998
- return pulumi.get(self, "name")
1999
-
2000
- @property
2001
- @pulumi.getter
2002
- def values(self) -> Sequence[str]:
2003
- return pulumi.get(self, "values")
2004
-
2005
- @property
2006
- @pulumi.getter
2007
- def regex(self) -> Optional[bool]:
2008
- return pulumi.get(self, "regex")
2009
-
2010
-
2011
- @pulumi.output_type
2012
- class GetAgentDataSourceDataSourceConfigResult(dict):
2013
- def __init__(__self__, *,
2014
- data_source_config_type: str,
2015
- object_storage_prefixes: Sequence['outputs.GetAgentDataSourceDataSourceConfigObjectStoragePrefixResult']):
2016
- """
2017
- :param str data_source_config_type: The type of the tool. The allowed values are:
2018
- * `OCI_OBJECT_STORAGE`: The data source is Oracle Cloud Infrastructure Object Storage.
2019
- :param Sequence['GetAgentDataSourceDataSourceConfigObjectStoragePrefixArgs'] object_storage_prefixes: The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
2020
- """
2021
- pulumi.set(__self__, "data_source_config_type", data_source_config_type)
2022
- pulumi.set(__self__, "object_storage_prefixes", object_storage_prefixes)
2023
-
2024
- @property
2025
- @pulumi.getter(name="dataSourceConfigType")
2026
- def data_source_config_type(self) -> str:
2027
- """
2028
- The type of the tool. The allowed values are:
2029
- * `OCI_OBJECT_STORAGE`: The data source is Oracle Cloud Infrastructure Object Storage.
2030
- """
2031
- return pulumi.get(self, "data_source_config_type")
2032
-
2033
- @property
2034
- @pulumi.getter(name="objectStoragePrefixes")
2035
- def object_storage_prefixes(self) -> Sequence['outputs.GetAgentDataSourceDataSourceConfigObjectStoragePrefixResult']:
2036
- """
2037
- The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
2038
- """
2039
- return pulumi.get(self, "object_storage_prefixes")
2040
-
2041
-
2042
- @pulumi.output_type
2043
- class GetAgentDataSourceDataSourceConfigObjectStoragePrefixResult(dict):
2044
- def __init__(__self__, *,
2045
- bucket: str,
2046
- namespace: str,
2047
- prefix: str):
2048
- """
2049
- :param str bucket: The bucket name of an object.
2050
- :param str namespace: The namespace name of an object.
2051
- :param str prefix: The name of the object (file) or prefix (folder).
2052
- """
2053
- pulumi.set(__self__, "bucket", bucket)
2054
- pulumi.set(__self__, "namespace", namespace)
2055
- pulumi.set(__self__, "prefix", prefix)
2056
-
2057
- @property
2058
- @pulumi.getter
2059
- def bucket(self) -> str:
2060
- """
2061
- The bucket name of an object.
2062
- """
2063
- return pulumi.get(self, "bucket")
2064
-
2065
- @property
2066
- @pulumi.getter
2067
- def namespace(self) -> str:
2068
- """
2069
- The namespace name of an object.
2070
- """
2071
- return pulumi.get(self, "namespace")
2072
-
2073
- @property
2074
- @pulumi.getter
2075
- def prefix(self) -> str:
2076
- """
2077
- The name of the object (file) or prefix (folder).
2078
- """
2079
- return pulumi.get(self, "prefix")
2080
-
2081
-
2082
- @pulumi.output_type
2083
- class GetAgentDataSourcesDataSourceCollectionResult(dict):
2084
- def __init__(__self__, *,
2085
- items: Sequence['outputs.GetAgentDataSourcesDataSourceCollectionItemResult']):
2086
- pulumi.set(__self__, "items", items)
2087
-
2088
- @property
2089
- @pulumi.getter
2090
- def items(self) -> Sequence['outputs.GetAgentDataSourcesDataSourceCollectionItemResult']:
2091
- return pulumi.get(self, "items")
2092
-
2093
-
2094
- @pulumi.output_type
2095
- class GetAgentDataSourcesDataSourceCollectionItemResult(dict):
2096
- def __init__(__self__, *,
2097
- compartment_id: str,
2098
- data_source_configs: Sequence['outputs.GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigResult'],
2099
- defined_tags: Mapping[str, str],
2100
- description: str,
2101
- display_name: str,
2102
- freeform_tags: Mapping[str, str],
2103
- id: str,
2104
- knowledge_base_id: str,
2105
- lifecycle_details: str,
2106
- state: str,
2107
- system_tags: Mapping[str, str],
2108
- time_created: str,
2109
- time_updated: str):
2110
- """
2111
- :param str compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
2112
- :param Sequence['GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigArgs'] data_source_configs: **DataSourceConfig**
2113
- :param Mapping[str, str] defined_tags: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
2114
- :param str description: A description of the data source.
2115
- :param str display_name: A filter to return only resources that match the given display name exactly.
2116
- :param Mapping[str, str] freeform_tags: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
2117
- :param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
2118
- :param str knowledge_base_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
2119
- :param str lifecycle_details: A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
2120
- :param str state: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
2121
- :param Mapping[str, str] system_tags: System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
2122
- :param str time_created: The date and time the data source was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2123
- :param str time_updated: The date and time the data source was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2124
- """
2125
- pulumi.set(__self__, "compartment_id", compartment_id)
2126
- pulumi.set(__self__, "data_source_configs", data_source_configs)
2127
- pulumi.set(__self__, "defined_tags", defined_tags)
2128
- pulumi.set(__self__, "description", description)
2129
- pulumi.set(__self__, "display_name", display_name)
2130
- pulumi.set(__self__, "freeform_tags", freeform_tags)
2131
- pulumi.set(__self__, "id", id)
2132
- pulumi.set(__self__, "knowledge_base_id", knowledge_base_id)
2133
- pulumi.set(__self__, "lifecycle_details", lifecycle_details)
2134
- pulumi.set(__self__, "state", state)
2135
- pulumi.set(__self__, "system_tags", system_tags)
2136
- pulumi.set(__self__, "time_created", time_created)
2137
- pulumi.set(__self__, "time_updated", time_updated)
2138
-
2139
- @property
2140
- @pulumi.getter(name="compartmentId")
2141
- def compartment_id(self) -> str:
2142
- """
2143
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
2144
- """
2145
- return pulumi.get(self, "compartment_id")
2146
-
2147
- @property
2148
- @pulumi.getter(name="dataSourceConfigs")
2149
- def data_source_configs(self) -> Sequence['outputs.GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigResult']:
2150
- """
2151
- **DataSourceConfig**
2152
- """
2153
- return pulumi.get(self, "data_source_configs")
2154
-
2155
- @property
2156
- @pulumi.getter(name="definedTags")
2157
- def defined_tags(self) -> Mapping[str, str]:
2158
- """
2159
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
2160
- """
2161
- return pulumi.get(self, "defined_tags")
2162
-
2163
- @property
2164
- @pulumi.getter
2165
- def description(self) -> str:
2166
- """
2167
- A description of the data source.
2168
- """
2169
- return pulumi.get(self, "description")
2170
-
2171
- @property
2172
- @pulumi.getter(name="displayName")
2173
- def display_name(self) -> str:
2174
- """
2175
- A filter to return only resources that match the given display name exactly.
2176
- """
2177
- return pulumi.get(self, "display_name")
2178
-
2179
- @property
2180
- @pulumi.getter(name="freeformTags")
2181
- def freeform_tags(self) -> Mapping[str, str]:
2182
- """
2183
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
2184
- """
2185
- return pulumi.get(self, "freeform_tags")
2186
-
2187
- @property
2188
- @pulumi.getter
2189
- def id(self) -> str:
2190
- """
2191
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source.
2192
- """
2193
- return pulumi.get(self, "id")
2194
-
2195
- @property
2196
- @pulumi.getter(name="knowledgeBaseId")
2197
- def knowledge_base_id(self) -> str:
2198
- """
2199
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
2200
- """
2201
- return pulumi.get(self, "knowledge_base_id")
2202
-
2203
- @property
2204
- @pulumi.getter(name="lifecycleDetails")
2205
- def lifecycle_details(self) -> str:
2206
- """
2207
- A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
2208
- """
2209
- return pulumi.get(self, "lifecycle_details")
2210
-
2211
- @property
2212
- @pulumi.getter
2213
- def state(self) -> str:
2214
- """
2215
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
2216
- """
2217
- return pulumi.get(self, "state")
2218
-
2219
- @property
2220
- @pulumi.getter(name="systemTags")
2221
- def system_tags(self) -> Mapping[str, str]:
2222
- """
2223
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
2224
- """
2225
- return pulumi.get(self, "system_tags")
2226
-
2227
- @property
2228
- @pulumi.getter(name="timeCreated")
2229
- def time_created(self) -> str:
2230
- """
2231
- The date and time the data source was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2232
- """
2233
- return pulumi.get(self, "time_created")
2234
-
2235
- @property
2236
- @pulumi.getter(name="timeUpdated")
2237
- def time_updated(self) -> str:
2238
- """
2239
- The date and time the data source was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2240
- """
2241
- return pulumi.get(self, "time_updated")
2242
-
2243
-
2244
- @pulumi.output_type
2245
- class GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigResult(dict):
2246
- def __init__(__self__, *,
2247
- data_source_config_type: str,
2248
- object_storage_prefixes: Sequence['outputs.GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefixResult']):
2249
- """
2250
- :param str data_source_config_type: The type of the tool. The allowed values are:
2251
- * `OCI_OBJECT_STORAGE`: The data source is Oracle Cloud Infrastructure Object Storage.
2252
- :param Sequence['GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefixArgs'] object_storage_prefixes: The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
2253
- """
2254
- pulumi.set(__self__, "data_source_config_type", data_source_config_type)
2255
- pulumi.set(__self__, "object_storage_prefixes", object_storage_prefixes)
2256
-
2257
- @property
2258
- @pulumi.getter(name="dataSourceConfigType")
2259
- def data_source_config_type(self) -> str:
2260
- """
2261
- The type of the tool. The allowed values are:
2262
- * `OCI_OBJECT_STORAGE`: The data source is Oracle Cloud Infrastructure Object Storage.
2263
- """
2264
- return pulumi.get(self, "data_source_config_type")
2265
-
2266
- @property
2267
- @pulumi.getter(name="objectStoragePrefixes")
2268
- def object_storage_prefixes(self) -> Sequence['outputs.GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefixResult']:
2269
- """
2270
- The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
2271
- """
2272
- return pulumi.get(self, "object_storage_prefixes")
2273
-
2274
-
2275
- @pulumi.output_type
2276
- class GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefixResult(dict):
2277
- def __init__(__self__, *,
2278
- bucket: str,
2279
- namespace: str,
2280
- prefix: str):
2281
- """
2282
- :param str bucket: The bucket name of an object.
2283
- :param str namespace: The namespace name of an object.
2284
- :param str prefix: The name of the object (file) or prefix (folder).
2285
- """
2286
- pulumi.set(__self__, "bucket", bucket)
2287
- pulumi.set(__self__, "namespace", namespace)
2288
- pulumi.set(__self__, "prefix", prefix)
2289
-
2290
- @property
2291
- @pulumi.getter
2292
- def bucket(self) -> str:
2293
- """
2294
- The bucket name of an object.
2295
- """
2296
- return pulumi.get(self, "bucket")
2297
-
2298
- @property
2299
- @pulumi.getter
2300
- def namespace(self) -> str:
2301
- """
2302
- The namespace name of an object.
2303
- """
2304
- return pulumi.get(self, "namespace")
2305
-
2306
- @property
2307
- @pulumi.getter
2308
- def prefix(self) -> str:
2309
- """
2310
- The name of the object (file) or prefix (folder).
2311
- """
2312
- return pulumi.get(self, "prefix")
2313
-
2314
-
2315
- @pulumi.output_type
2316
- class GetAgentDataSourcesFilterResult(dict):
2317
- def __init__(__self__, *,
2318
- name: str,
2319
- values: Sequence[str],
2320
- regex: Optional[bool] = None):
2321
- pulumi.set(__self__, "name", name)
2322
- pulumi.set(__self__, "values", values)
2323
- if regex is not None:
2324
- pulumi.set(__self__, "regex", regex)
2325
-
2326
- @property
2327
- @pulumi.getter
2328
- def name(self) -> str:
2329
- return pulumi.get(self, "name")
2330
-
2331
- @property
2332
- @pulumi.getter
2333
- def values(self) -> Sequence[str]:
2334
- return pulumi.get(self, "values")
2335
-
2336
- @property
2337
- @pulumi.getter
2338
- def regex(self) -> Optional[bool]:
2339
- return pulumi.get(self, "regex")
2340
-
2341
-
2342
- @pulumi.output_type
2343
- class GetAgentKnowledgeBaseIndexConfigResult(dict):
2344
- def __init__(__self__, *,
2345
- cluster_id: str,
2346
- database_connections: Sequence['outputs.GetAgentKnowledgeBaseIndexConfigDatabaseConnectionResult'],
2347
- database_functions: Sequence['outputs.GetAgentKnowledgeBaseIndexConfigDatabaseFunctionResult'],
2348
- index_config_type: str,
2349
- indexes: Sequence['outputs.GetAgentKnowledgeBaseIndexConfigIndexResult'],
2350
- secret_details: Sequence['outputs.GetAgentKnowledgeBaseIndexConfigSecretDetailResult'],
2351
- should_enable_hybrid_search: bool):
2352
- """
2353
- :param str cluster_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
2354
- :param Sequence['GetAgentKnowledgeBaseIndexConfigDatabaseConnectionArgs'] database_connections: **DatabaseConnection**
2355
- :param Sequence['GetAgentKnowledgeBaseIndexConfigDatabaseFunctionArgs'] database_functions: Array of Database functions to be used.
2356
- :param str index_config_type: The type of index. The allowed values are:
2357
- * `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
2358
- * `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
2359
- * `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
2360
- :param Sequence['GetAgentKnowledgeBaseIndexConfigIndexArgs'] indexes: Index configuration for open search.
2361
- :param Sequence['GetAgentKnowledgeBaseIndexConfigSecretDetailArgs'] secret_details: **SecretDetail**
2362
- :param bool should_enable_hybrid_search: Whether to enable Hybrid search in service managed OpenSearch.
2363
- """
2364
- pulumi.set(__self__, "cluster_id", cluster_id)
2365
- pulumi.set(__self__, "database_connections", database_connections)
2366
- pulumi.set(__self__, "database_functions", database_functions)
2367
- pulumi.set(__self__, "index_config_type", index_config_type)
2368
- pulumi.set(__self__, "indexes", indexes)
2369
- pulumi.set(__self__, "secret_details", secret_details)
2370
- pulumi.set(__self__, "should_enable_hybrid_search", should_enable_hybrid_search)
2371
-
2372
- @property
2373
- @pulumi.getter(name="clusterId")
2374
- def cluster_id(self) -> str:
2375
- """
2376
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
2377
- """
2378
- return pulumi.get(self, "cluster_id")
2379
-
2380
- @property
2381
- @pulumi.getter(name="databaseConnections")
2382
- def database_connections(self) -> Sequence['outputs.GetAgentKnowledgeBaseIndexConfigDatabaseConnectionResult']:
2383
- """
2384
- **DatabaseConnection**
2385
- """
2386
- return pulumi.get(self, "database_connections")
2387
-
2388
- @property
2389
- @pulumi.getter(name="databaseFunctions")
2390
- def database_functions(self) -> Sequence['outputs.GetAgentKnowledgeBaseIndexConfigDatabaseFunctionResult']:
2391
- """
2392
- Array of Database functions to be used.
2393
- """
2394
- return pulumi.get(self, "database_functions")
2395
-
2396
- @property
2397
- @pulumi.getter(name="indexConfigType")
2398
- def index_config_type(self) -> str:
2399
- """
2400
- The type of index. The allowed values are:
2401
- * `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
2402
- * `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
2403
- * `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
2404
- """
2405
- return pulumi.get(self, "index_config_type")
2406
-
2407
- @property
2408
- @pulumi.getter
2409
- def indexes(self) -> Sequence['outputs.GetAgentKnowledgeBaseIndexConfigIndexResult']:
2410
- """
2411
- Index configuration for open search.
2412
- """
2413
- return pulumi.get(self, "indexes")
2414
-
2415
- @property
2416
- @pulumi.getter(name="secretDetails")
2417
- def secret_details(self) -> Sequence['outputs.GetAgentKnowledgeBaseIndexConfigSecretDetailResult']:
2418
- """
2419
- **SecretDetail**
2420
- """
2421
- return pulumi.get(self, "secret_details")
2422
-
2423
- @property
2424
- @pulumi.getter(name="shouldEnableHybridSearch")
2425
- def should_enable_hybrid_search(self) -> bool:
2426
- """
2427
- Whether to enable Hybrid search in service managed OpenSearch.
2428
- """
2429
- return pulumi.get(self, "should_enable_hybrid_search")
2430
-
2431
-
2432
- @pulumi.output_type
2433
- class GetAgentKnowledgeBaseIndexConfigDatabaseConnectionResult(dict):
2434
- def __init__(__self__, *,
2435
- connection_id: str,
2436
- connection_type: str):
2437
- """
2438
- :param str connection_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
2439
- :param str connection_type: The type of Database connection. The allowed values are:
2440
- * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
2441
- """
2442
- pulumi.set(__self__, "connection_id", connection_id)
2443
- pulumi.set(__self__, "connection_type", connection_type)
2444
-
2445
- @property
2446
- @pulumi.getter(name="connectionId")
2447
- def connection_id(self) -> str:
2448
- """
2449
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
2450
- """
2451
- return pulumi.get(self, "connection_id")
2452
-
2453
- @property
2454
- @pulumi.getter(name="connectionType")
2455
- def connection_type(self) -> str:
2456
- """
2457
- The type of Database connection. The allowed values are:
2458
- * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
2459
- """
2460
- return pulumi.get(self, "connection_type")
2461
-
2462
-
2463
- @pulumi.output_type
2464
- class GetAgentKnowledgeBaseIndexConfigDatabaseFunctionResult(dict):
2465
- def __init__(__self__, *,
2466
- name: str):
2467
- """
2468
- :param str name: The index name in opensearch.
2469
- """
2470
- pulumi.set(__self__, "name", name)
2471
-
2472
- @property
2473
- @pulumi.getter
2474
- def name(self) -> str:
2475
- """
2476
- The index name in opensearch.
2477
- """
2478
- return pulumi.get(self, "name")
2479
-
2480
-
2481
- @pulumi.output_type
2482
- class GetAgentKnowledgeBaseIndexConfigIndexResult(dict):
2483
- def __init__(__self__, *,
2484
- name: str,
2485
- schemas: Sequence['outputs.GetAgentKnowledgeBaseIndexConfigIndexSchemaResult']):
2486
- """
2487
- :param str name: The index name in opensearch.
2488
- :param Sequence['GetAgentKnowledgeBaseIndexConfigIndexSchemaArgs'] schemas: **IndexSchema**
2489
- """
2490
- pulumi.set(__self__, "name", name)
2491
- pulumi.set(__self__, "schemas", schemas)
2492
-
2493
- @property
2494
- @pulumi.getter
2495
- def name(self) -> str:
2496
- """
2497
- The index name in opensearch.
2498
- """
2499
- return pulumi.get(self, "name")
2500
-
2501
- @property
2502
- @pulumi.getter
2503
- def schemas(self) -> Sequence['outputs.GetAgentKnowledgeBaseIndexConfigIndexSchemaResult']:
2504
- """
2505
- **IndexSchema**
2506
- """
2507
- return pulumi.get(self, "schemas")
2508
-
2509
-
2510
- @pulumi.output_type
2511
- class GetAgentKnowledgeBaseIndexConfigIndexSchemaResult(dict):
2512
- def __init__(__self__, *,
2513
- body_key: str,
2514
- embedding_body_key: str,
2515
- title_key: str,
2516
- url_key: str):
2517
- """
2518
- :param str body_key: Body key name.
2519
- :param str embedding_body_key: Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
2520
- :param str title_key: Title key that stores the Title of a document, if available.
2521
- :param str url_key: URL key that stores the URL of a document, if available.
2522
- """
2523
- pulumi.set(__self__, "body_key", body_key)
2524
- pulumi.set(__self__, "embedding_body_key", embedding_body_key)
2525
- pulumi.set(__self__, "title_key", title_key)
2526
- pulumi.set(__self__, "url_key", url_key)
2527
-
2528
- @property
2529
- @pulumi.getter(name="bodyKey")
2530
- def body_key(self) -> str:
2531
- """
2532
- Body key name.
2533
- """
2534
- return pulumi.get(self, "body_key")
2535
-
2536
- @property
2537
- @pulumi.getter(name="embeddingBodyKey")
2538
- def embedding_body_key(self) -> str:
2539
- """
2540
- Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
2541
- """
2542
- return pulumi.get(self, "embedding_body_key")
2543
-
2544
- @property
2545
- @pulumi.getter(name="titleKey")
2546
- def title_key(self) -> str:
2547
- """
2548
- Title key that stores the Title of a document, if available.
2549
- """
2550
- return pulumi.get(self, "title_key")
2551
-
2552
- @property
2553
- @pulumi.getter(name="urlKey")
2554
- def url_key(self) -> str:
2555
- """
2556
- URL key that stores the URL of a document, if available.
2557
- """
2558
- return pulumi.get(self, "url_key")
2559
-
2560
-
2561
- @pulumi.output_type
2562
- class GetAgentKnowledgeBaseIndexConfigSecretDetailResult(dict):
2563
- def __init__(__self__, *,
2564
- client_id: str,
2565
- idcs_url: str,
2566
- scope_url: str,
2567
- type: str,
2568
- vault_secret_id: str):
2569
- """
2570
- :param str client_id: The IDCS Connect clientId.
2571
- :param str idcs_url: The URL represent authentication url of the IDCS.
2572
- :param str scope_url: Fully qualified scope url
2573
- :param str type: The type of OpenID. The allowed values are:
2574
- * `IDCS_SECRET`: The OpenID configuration used is OpenSearch is IDCS.
2575
- * `BASIC_AUTH_SECRET`: Basic authentication use for OpenSearch
2576
- :param str vault_secret_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
2577
- """
2578
- pulumi.set(__self__, "client_id", client_id)
2579
- pulumi.set(__self__, "idcs_url", idcs_url)
2580
- pulumi.set(__self__, "scope_url", scope_url)
2581
- pulumi.set(__self__, "type", type)
2582
- pulumi.set(__self__, "vault_secret_id", vault_secret_id)
2583
-
2584
- @property
2585
- @pulumi.getter(name="clientId")
2586
- def client_id(self) -> str:
2587
- """
2588
- The IDCS Connect clientId.
2589
- """
2590
- return pulumi.get(self, "client_id")
2591
-
2592
- @property
2593
- @pulumi.getter(name="idcsUrl")
2594
- def idcs_url(self) -> str:
2595
- """
2596
- The URL represent authentication url of the IDCS.
2597
- """
2598
- return pulumi.get(self, "idcs_url")
2599
-
2600
- @property
2601
- @pulumi.getter(name="scopeUrl")
2602
- def scope_url(self) -> str:
2603
- """
2604
- Fully qualified scope url
2605
- """
2606
- return pulumi.get(self, "scope_url")
2607
-
2608
- @property
2609
- @pulumi.getter
2610
- def type(self) -> str:
2611
- """
2612
- The type of OpenID. The allowed values are:
2613
- * `IDCS_SECRET`: The OpenID configuration used is OpenSearch is IDCS.
2614
- * `BASIC_AUTH_SECRET`: Basic authentication use for OpenSearch
2615
- """
2616
- return pulumi.get(self, "type")
2617
-
2618
- @property
2619
- @pulumi.getter(name="vaultSecretId")
2620
- def vault_secret_id(self) -> str:
2621
- """
2622
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
2623
- """
2624
- return pulumi.get(self, "vault_secret_id")
2625
-
2626
-
2627
- @pulumi.output_type
2628
- class GetAgentKnowledgeBasesFilterResult(dict):
2629
- def __init__(__self__, *,
2630
- name: str,
2631
- values: Sequence[str],
2632
- regex: Optional[bool] = None):
2633
- """
2634
- :param str name: The index name in opensearch.
2635
- """
2636
- pulumi.set(__self__, "name", name)
2637
- pulumi.set(__self__, "values", values)
2638
- if regex is not None:
2639
- pulumi.set(__self__, "regex", regex)
2640
-
2641
- @property
2642
- @pulumi.getter
2643
- def name(self) -> str:
2644
- """
2645
- The index name in opensearch.
2646
- """
2647
- return pulumi.get(self, "name")
2648
-
2649
- @property
2650
- @pulumi.getter
2651
- def values(self) -> Sequence[str]:
2652
- return pulumi.get(self, "values")
2653
-
2654
- @property
2655
- @pulumi.getter
2656
- def regex(self) -> Optional[bool]:
2657
- return pulumi.get(self, "regex")
2658
-
2659
-
2660
- @pulumi.output_type
2661
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionResult(dict):
2662
- def __init__(__self__, *,
2663
- items: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemResult']):
2664
- pulumi.set(__self__, "items", items)
2665
-
2666
- @property
2667
- @pulumi.getter
2668
- def items(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemResult']:
2669
- return pulumi.get(self, "items")
2670
-
2671
-
2672
- @pulumi.output_type
2673
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemResult(dict):
2674
- def __init__(__self__, *,
2675
- compartment_id: str,
2676
- defined_tags: Mapping[str, str],
2677
- description: str,
2678
- display_name: str,
2679
- freeform_tags: Mapping[str, str],
2680
- id: str,
2681
- index_configs: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigResult'],
2682
- lifecycle_details: str,
2683
- state: str,
2684
- system_tags: Mapping[str, str],
2685
- time_created: str,
2686
- time_updated: str):
2687
- """
2688
- :param str compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
2689
- :param Mapping[str, str] defined_tags: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
2690
- :param str description: A description of the knowledge base.
2691
- :param str display_name: A filter to return only resources that match the given display name exactly.
2692
- :param Mapping[str, str] freeform_tags: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
2693
- :param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
2694
- :param Sequence['GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigArgs'] index_configs: **IndexConfig**
2695
- :param str lifecycle_details: A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
2696
- :param str state: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
2697
- :param Mapping[str, str] system_tags: System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
2698
- :param str time_created: The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2699
- :param str time_updated: The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2700
- """
2701
- pulumi.set(__self__, "compartment_id", compartment_id)
2702
- pulumi.set(__self__, "defined_tags", defined_tags)
2703
- pulumi.set(__self__, "description", description)
2704
- pulumi.set(__self__, "display_name", display_name)
2705
- pulumi.set(__self__, "freeform_tags", freeform_tags)
2706
- pulumi.set(__self__, "id", id)
2707
- pulumi.set(__self__, "index_configs", index_configs)
2708
- pulumi.set(__self__, "lifecycle_details", lifecycle_details)
2709
- pulumi.set(__self__, "state", state)
2710
- pulumi.set(__self__, "system_tags", system_tags)
2711
- pulumi.set(__self__, "time_created", time_created)
2712
- pulumi.set(__self__, "time_updated", time_updated)
2713
-
2714
- @property
2715
- @pulumi.getter(name="compartmentId")
2716
- def compartment_id(self) -> str:
2717
- """
2718
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
2719
- """
2720
- return pulumi.get(self, "compartment_id")
2721
-
2722
- @property
2723
- @pulumi.getter(name="definedTags")
2724
- def defined_tags(self) -> Mapping[str, str]:
2725
- """
2726
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
2727
- """
2728
- return pulumi.get(self, "defined_tags")
2729
-
2730
- @property
2731
- @pulumi.getter
2732
- def description(self) -> str:
2733
- """
2734
- A description of the knowledge base.
2735
- """
2736
- return pulumi.get(self, "description")
2737
-
2738
- @property
2739
- @pulumi.getter(name="displayName")
2740
- def display_name(self) -> str:
2741
- """
2742
- A filter to return only resources that match the given display name exactly.
2743
- """
2744
- return pulumi.get(self, "display_name")
2745
-
2746
- @property
2747
- @pulumi.getter(name="freeformTags")
2748
- def freeform_tags(self) -> Mapping[str, str]:
2749
- """
2750
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
2751
- """
2752
- return pulumi.get(self, "freeform_tags")
2753
-
2754
- @property
2755
- @pulumi.getter
2756
- def id(self) -> str:
2757
- """
2758
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base.
2759
- """
2760
- return pulumi.get(self, "id")
2761
-
2762
- @property
2763
- @pulumi.getter(name="indexConfigs")
2764
- def index_configs(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigResult']:
2765
- """
2766
- **IndexConfig**
2767
- """
2768
- return pulumi.get(self, "index_configs")
2769
-
2770
- @property
2771
- @pulumi.getter(name="lifecycleDetails")
2772
- def lifecycle_details(self) -> str:
2773
- """
2774
- A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
2775
- """
2776
- return pulumi.get(self, "lifecycle_details")
2777
-
2778
- @property
2779
- @pulumi.getter
2780
- def state(self) -> str:
2781
- """
2782
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
2783
- """
2784
- return pulumi.get(self, "state")
2785
-
2786
- @property
2787
- @pulumi.getter(name="systemTags")
2788
- def system_tags(self) -> Mapping[str, str]:
2789
- """
2790
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}`
2791
- """
2792
- return pulumi.get(self, "system_tags")
2793
-
2794
- @property
2795
- @pulumi.getter(name="timeCreated")
2796
- def time_created(self) -> str:
2797
- """
2798
- The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2799
- """
2800
- return pulumi.get(self, "time_created")
2801
-
2802
- @property
2803
- @pulumi.getter(name="timeUpdated")
2804
- def time_updated(self) -> str:
2805
- """
2806
- The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
2807
- """
2808
- return pulumi.get(self, "time_updated")
2809
-
2810
-
2811
- @pulumi.output_type
2812
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigResult(dict):
2813
- def __init__(__self__, *,
2814
- cluster_id: str,
2815
- database_connections: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnectionResult'],
2816
- database_functions: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunctionResult'],
2817
- index_config_type: str,
2818
- indexes: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexResult'],
2819
- secret_details: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetailResult'],
2820
- should_enable_hybrid_search: bool):
2821
- """
2822
- :param str cluster_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
2823
- :param Sequence['GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnectionArgs'] database_connections: **DatabaseConnection**
2824
- :param Sequence['GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunctionArgs'] database_functions: Array of Database functions to be used.
2825
- :param str index_config_type: The type of index. The allowed values are:
2826
- * `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
2827
- * `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
2828
- * `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
2829
- :param Sequence['GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexArgs'] indexes: Index configuration for open search.
2830
- :param Sequence['GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetailArgs'] secret_details: **SecretDetail**
2831
- :param bool should_enable_hybrid_search: Whether to enable Hybrid search in service managed OpenSearch.
2832
- """
2833
- pulumi.set(__self__, "cluster_id", cluster_id)
2834
- pulumi.set(__self__, "database_connections", database_connections)
2835
- pulumi.set(__self__, "database_functions", database_functions)
2836
- pulumi.set(__self__, "index_config_type", index_config_type)
2837
- pulumi.set(__self__, "indexes", indexes)
2838
- pulumi.set(__self__, "secret_details", secret_details)
2839
- pulumi.set(__self__, "should_enable_hybrid_search", should_enable_hybrid_search)
2840
-
2841
- @property
2842
- @pulumi.getter(name="clusterId")
2843
- def cluster_id(self) -> str:
2844
- """
2845
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster.
2846
- """
2847
- return pulumi.get(self, "cluster_id")
2848
-
2849
- @property
2850
- @pulumi.getter(name="databaseConnections")
2851
- def database_connections(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnectionResult']:
2852
- """
2853
- **DatabaseConnection**
2854
- """
2855
- return pulumi.get(self, "database_connections")
2856
-
2857
- @property
2858
- @pulumi.getter(name="databaseFunctions")
2859
- def database_functions(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunctionResult']:
2860
- """
2861
- Array of Database functions to be used.
2862
- """
2863
- return pulumi.get(self, "database_functions")
2864
-
2865
- @property
2866
- @pulumi.getter(name="indexConfigType")
2867
- def index_config_type(self) -> str:
2868
- """
2869
- The type of index. The allowed values are:
2870
- * `DEFAULT_INDEX_CONFIG`: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
2871
- * `OCI_OPEN_SEARCH_INDEX_CONFIG`: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
2872
- * `OCI_DATABASE_CONFIG`: OciDatabaseConfig allows customer to configure their Database.
2873
- """
2874
- return pulumi.get(self, "index_config_type")
2875
-
2876
- @property
2877
- @pulumi.getter
2878
- def indexes(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexResult']:
2879
- """
2880
- Index configuration for open search.
2881
- """
2882
- return pulumi.get(self, "indexes")
2883
-
2884
- @property
2885
- @pulumi.getter(name="secretDetails")
2886
- def secret_details(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetailResult']:
2887
- """
2888
- **SecretDetail**
2889
- """
2890
- return pulumi.get(self, "secret_details")
2891
-
2892
- @property
2893
- @pulumi.getter(name="shouldEnableHybridSearch")
2894
- def should_enable_hybrid_search(self) -> bool:
2895
- """
2896
- Whether to enable Hybrid search in service managed OpenSearch.
2897
- """
2898
- return pulumi.get(self, "should_enable_hybrid_search")
2899
-
2900
-
2901
- @pulumi.output_type
2902
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnectionResult(dict):
2903
- def __init__(__self__, *,
2904
- connection_id: str,
2905
- connection_type: str):
2906
- """
2907
- :param str connection_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
2908
- :param str connection_type: The type of Database connection. The allowed values are:
2909
- * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
2910
- """
2911
- pulumi.set(__self__, "connection_id", connection_id)
2912
- pulumi.set(__self__, "connection_type", connection_type)
2913
-
2914
- @property
2915
- @pulumi.getter(name="connectionId")
2916
- def connection_id(self) -> str:
2917
- """
2918
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection.
2919
- """
2920
- return pulumi.get(self, "connection_id")
2921
-
2922
- @property
2923
- @pulumi.getter(name="connectionType")
2924
- def connection_type(self) -> str:
2925
- """
2926
- The type of Database connection. The allowed values are:
2927
- * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection.
2928
- """
2929
- return pulumi.get(self, "connection_type")
2930
-
2931
-
2932
- @pulumi.output_type
2933
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunctionResult(dict):
2934
- def __init__(__self__, *,
2935
- name: str):
2936
- """
2937
- :param str name: The index name in opensearch.
2938
- """
2939
- pulumi.set(__self__, "name", name)
2940
-
2941
- @property
2942
- @pulumi.getter
2943
- def name(self) -> str:
2944
- """
2945
- The index name in opensearch.
2946
- """
2947
- return pulumi.get(self, "name")
2948
-
2949
-
2950
- @pulumi.output_type
2951
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexResult(dict):
2952
- def __init__(__self__, *,
2953
- name: str,
2954
- schemas: Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchemaResult']):
2955
- """
2956
- :param str name: The index name in opensearch.
2957
- :param Sequence['GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchemaArgs'] schemas: **IndexSchema**
2958
- """
2959
- pulumi.set(__self__, "name", name)
2960
- pulumi.set(__self__, "schemas", schemas)
2961
-
2962
- @property
2963
- @pulumi.getter
2964
- def name(self) -> str:
2965
- """
2966
- The index name in opensearch.
2967
- """
2968
- return pulumi.get(self, "name")
2969
-
2970
- @property
2971
- @pulumi.getter
2972
- def schemas(self) -> Sequence['outputs.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchemaResult']:
2973
- """
2974
- **IndexSchema**
2975
- """
2976
- return pulumi.get(self, "schemas")
2977
-
2978
-
2979
- @pulumi.output_type
2980
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchemaResult(dict):
2981
- def __init__(__self__, *,
2982
- body_key: str,
2983
- embedding_body_key: str,
2984
- title_key: str,
2985
- url_key: str):
2986
- """
2987
- :param str body_key: Body key name.
2988
- :param str embedding_body_key: Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
2989
- :param str title_key: Title key that stores the Title of a document, if available.
2990
- :param str url_key: URL key that stores the URL of a document, if available.
2991
- """
2992
- pulumi.set(__self__, "body_key", body_key)
2993
- pulumi.set(__self__, "embedding_body_key", embedding_body_key)
2994
- pulumi.set(__self__, "title_key", title_key)
2995
- pulumi.set(__self__, "url_key", url_key)
2996
-
2997
- @property
2998
- @pulumi.getter(name="bodyKey")
2999
- def body_key(self) -> str:
3000
- """
3001
- Body key name.
3002
- """
3003
- return pulumi.get(self, "body_key")
3004
-
3005
- @property
3006
- @pulumi.getter(name="embeddingBodyKey")
3007
- def embedding_body_key(self) -> str:
3008
- """
3009
- Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
3010
- """
3011
- return pulumi.get(self, "embedding_body_key")
3012
-
3013
- @property
3014
- @pulumi.getter(name="titleKey")
3015
- def title_key(self) -> str:
3016
- """
3017
- Title key that stores the Title of a document, if available.
3018
- """
3019
- return pulumi.get(self, "title_key")
3020
-
3021
- @property
3022
- @pulumi.getter(name="urlKey")
3023
- def url_key(self) -> str:
3024
- """
3025
- URL key that stores the URL of a document, if available.
3026
- """
3027
- return pulumi.get(self, "url_key")
3028
-
3029
-
3030
- @pulumi.output_type
3031
- class GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetailResult(dict):
3032
- def __init__(__self__, *,
3033
- client_id: str,
3034
- idcs_url: str,
3035
- scope_url: str,
3036
- type: str,
3037
- vault_secret_id: str):
3038
- """
3039
- :param str client_id: The IDCS Connect clientId.
3040
- :param str idcs_url: The URL represent authentication url of the IDCS.
3041
- :param str scope_url: Fully qualified scope url
3042
- :param str type: The type of OpenID. The allowed values are:
3043
- * `IDCS_SECRET`: The OpenID configuration used is OpenSearch is IDCS.
3044
- * `BASIC_AUTH_SECRET`: Basic authentication use for OpenSearch
3045
- :param str vault_secret_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
3046
- """
3047
- pulumi.set(__self__, "client_id", client_id)
3048
- pulumi.set(__self__, "idcs_url", idcs_url)
3049
- pulumi.set(__self__, "scope_url", scope_url)
3050
- pulumi.set(__self__, "type", type)
3051
- pulumi.set(__self__, "vault_secret_id", vault_secret_id)
3052
-
3053
- @property
3054
- @pulumi.getter(name="clientId")
3055
- def client_id(self) -> str:
3056
- """
3057
- The IDCS Connect clientId.
3058
- """
3059
- return pulumi.get(self, "client_id")
3060
-
3061
- @property
3062
- @pulumi.getter(name="idcsUrl")
3063
- def idcs_url(self) -> str:
3064
- """
3065
- The URL represent authentication url of the IDCS.
3066
- """
3067
- return pulumi.get(self, "idcs_url")
3068
-
3069
- @property
3070
- @pulumi.getter(name="scopeUrl")
3071
- def scope_url(self) -> str:
3072
- """
3073
- Fully qualified scope url
3074
- """
3075
- return pulumi.get(self, "scope_url")
3076
-
3077
- @property
3078
- @pulumi.getter
3079
- def type(self) -> str:
3080
- """
3081
- The type of OpenID. The allowed values are:
3082
- * `IDCS_SECRET`: The OpenID configuration used is OpenSearch is IDCS.
3083
- * `BASIC_AUTH_SECRET`: Basic authentication use for OpenSearch
3084
- """
3085
- return pulumi.get(self, "type")
3086
-
3087
- @property
3088
- @pulumi.getter(name="vaultSecretId")
3089
- def vault_secret_id(self) -> str:
3090
- """
3091
- The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication.
3092
- """
3093
- return pulumi.get(self, "vault_secret_id")
521
+ return pulumi.get(self, "model_metrics_type")
3094
522
 
3095
523
 
3096
524
  @pulumi.output_type