Class: DatadogAPIClient::V2::AgentObservabilityAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/agent_observability_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ AgentObservabilityAPI

Returns a new instance of AgentObservabilityAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#aggregate_llm_obs_experimentation(body, opts = {}) ⇒ Object

Aggregate Agent Observability experimentation.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 29

def aggregate_llm_obs_experimentation(body, opts = {})
  data, _status_code, _headers = aggregate_llm_obs_experimentation_with_http_info(body, opts)
  data
end

#aggregate_llm_obs_experimentation_with_http_info(body, opts = {}) ⇒ Array<(LLMObsExperimentationAnalyticsResponse, Integer, Hash)>

Aggregate Agent Observability experimentation.

Execute an analytics aggregation over Agent Observability experimentation data. Use this endpoint to compute metrics (for example average eval scores) grouped by fields such as span_id or experiment_id.

At least one compute definition and one index must be provided.

Parameters:

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 44

def aggregate_llm_obs_experimentation_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.aggregate_llm_obs_experimentation".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.aggregate_llm_obs_experimentation")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.aggregate_llm_obs_experimentation"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.aggregate_llm_obs_experimentation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.aggregate_llm_obs_experimentation"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experimentation/analytics'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentationAnalyticsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :aggregate_llm_obs_experimentation,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#aggregate_llm_obs_experimentation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#batch_update_llm_obs_dataset(project_id, dataset_id, body, opts = {}) ⇒ Object

Batch update Agent Observability dataset records.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 105

def batch_update_llm_obs_dataset(project_id, dataset_id, body, opts = {})
  data, _status_code, _headers = batch_update_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts)
  data
end

#batch_update_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(LLMObsDatasetRecordsMutationResponse, Integer, Hash)>

Batch update Agent Observability dataset records.

Insert, update, and delete records in a single dataset operation. By default, a new dataset version is created when the batch is applied.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • body (LLMObsDatasetBatchUpdateRequest) —

    Batch update payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 119

def batch_update_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.batch_update_llm_obs_dataset".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.batch_update_llm_obs_dataset")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.batch_update_llm_obs_dataset"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.batch_update_llm_obs_dataset ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.batch_update_llm_obs_dataset"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.batch_update_llm_obs_dataset"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.batch_update_llm_obs_dataset"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/batch_update'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetRecordsMutationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :batch_update_llm_obs_dataset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#batch_update_llm_obs_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#clone_llm_obs_dataset(project_id, dataset_id, body, opts = {}) ⇒ Object

Clone an Agent Observability dataset.

See Also:



188
189
190
191
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 188

def clone_llm_obs_dataset(project_id, dataset_id, body, opts = {})
  data, _status_code, _headers = clone_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts)
  data
end

#clone_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(LLMObsDatasetResponse, Integer, Hash)>

Clone an Agent Observability dataset.

Clone a dataset, copying its current records into a new dataset within the same project.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the source Agent Observability dataset to clone.

  • body (LLMObsDatasetCloneRequest) —

    Clone dataset payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsDatasetResponse, Integer, Hash)>) —

    LLMObsDatasetResponse data, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 202

def clone_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.clone_llm_obs_dataset".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.clone_llm_obs_dataset")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.clone_llm_obs_dataset"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.clone_llm_obs_dataset ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.clone_llm_obs_dataset"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.clone_llm_obs_dataset"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.clone_llm_obs_dataset"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/clone'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :clone_llm_obs_dataset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#clone_llm_obs_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_annotation_queue(body, opts = {}) ⇒ Object

Create an Agent Observability annotation queue.

See Also:



271
272
273
274
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 271

def create_llm_obs_annotation_queue(body, opts = {})
  data, _status_code, _headers = create_llm_obs_annotation_queue_with_http_info(body, opts)
  data
end

#create_llm_obs_annotation_queue_interactions(queue_id, body, opts = {}) ⇒ Object

Add annotation queue interactions.

See Also:



348
349
350
351
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 348

def create_llm_obs_annotation_queue_interactions(queue_id, body, opts = {})
  data, _status_code, _headers = create_llm_obs_annotation_queue_interactions_with_http_info(queue_id, body, opts)
  data
end

#create_llm_obs_annotation_queue_interactions_with_http_info(queue_id, body, opts = {}) ⇒ Array<(LLMObsAnnotationQueueInteractionsResponse, Integer, Hash)>

Add annotation queue interactions.

Add one or more interactions to an annotation queue. At least one interaction must be provided. Each interaction has a type:

  • trace, experiment_trace, session: content_id references the upstream entity; the server fetches the actual content.
  • display_block: omit content_id and provide the rendered content in display_block. The server generates content_id as a deterministic hash of the block list.

Items of different types can be mixed in a single request.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • body (LLMObsAnnotationQueueInteractionsRequest) —

    Add interactions payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 370

def create_llm_obs_annotation_queue_interactions_with_http_info(queue_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_annotation_queue_interactions".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_annotation_queue_interactions")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_annotation_queue_interactions"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_annotation_queue_interactions ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.create_llm_obs_annotation_queue_interactions"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_annotation_queue_interactions"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactions'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationQueueInteractionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_annotation_queue_interactions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_annotation_queue_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_annotation_queue_with_http_info(body, opts = {}) ⇒ Array<(LLMObsAnnotationQueueResponse, Integer, Hash)>

Create an Agent Observability annotation queue.

Create an annotation queue. The name and project_id fields are required. An optional annotation_schema can be provided to define the labels for the queue. Optional access-control fields can restrict annotation access to reviewers or assignees. Fields such as created_by, owned_by, created_at, modified_by, and modified_at are inferred by the backend.

Parameters:

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 287

def create_llm_obs_annotation_queue_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_annotation_queue".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_annotation_queue")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_annotation_queue"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_annotation_queue ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_annotation_queue"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationQueueResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_annotation_queue,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_annotation_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_dataset(project_id, body, opts = {}) ⇒ Object

Create an Agent Observability dataset.

See Also:



435
436
437
438
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 435

def create_llm_obs_dataset(project_id, body, opts = {})
  data, _status_code, _headers = create_llm_obs_dataset_with_http_info(project_id, body, opts)
  data
end

#create_llm_obs_dataset_records(project_id, dataset_id, body, opts = {}) ⇒ Object

Append records to an Agent Observability dataset.

See Also:



513
514
515
516
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 513

def create_llm_obs_dataset_records(project_id, dataset_id, body, opts = {})
  data, _status_code, _headers = create_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts)
  data
end

#create_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(LLMObsDatasetRecordsMutationResponse, Integer, Hash)>

Append records to an Agent Observability dataset.

Append one or more records to an Agent Observability dataset.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • body (LLMObsDatasetRecordsRequest) —

    Append records payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 527

def create_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_dataset_records".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_dataset_records")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_dataset_records"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_dataset_records ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.create_llm_obs_dataset_records"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.create_llm_obs_dataset_records"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_dataset_records"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetRecordsMutationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_dataset_records,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_dataset_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_dataset_with_http_info(project_id, body, opts = {}) ⇒ Array<(LLMObsDatasetResponse, Integer, Hash)>

Create an Agent Observability dataset.

Create a new Agent Observability dataset within the specified project.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • body (LLMObsDatasetRequest) —

    Create dataset payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsDatasetResponse, Integer, Hash)>) —

    LLMObsDatasetResponse data, response status code and response headers



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 448

def create_llm_obs_dataset_with_http_info(project_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_dataset".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_dataset")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_dataset"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_dataset ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.create_llm_obs_dataset"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_dataset"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_dataset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_experiment(body, opts = {}) ⇒ Object

Create an Agent Observability experiment.

See Also:



596
597
598
599
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 596

def create_llm_obs_experiment(body, opts = {})
  data, _status_code, _headers = create_llm_obs_experiment_with_http_info(body, opts)
  data
end

#create_llm_obs_experiment_events(experiment_id, body, opts = {}) ⇒ Object

Push events for an Agent Observability experiment.

See Also:



669
670
671
672
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 669

def create_llm_obs_experiment_events(experiment_id, body, opts = {})
  create_llm_obs_experiment_events_with_http_info(experiment_id, body, opts)
  nil
end

#create_llm_obs_experiment_events_with_http_info(experiment_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Push events for an Agent Observability experiment.

Push spans and metrics for an Agent Observability experiment.

Parameters:

  • experiment_id (String) —

    The ID of the Agent Observability experiment.

  • body (LLMObsExperimentEventsRequest) —

    Experiment events payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 682

def create_llm_obs_experiment_events_with_http_info(experiment_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_experiment_events".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_experiment_events")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_experiment_events"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_experiment_events ...'
  end
  # verify the required parameter 'experiment_id' is set
  if @api_client.config.client_side_validation && experiment_id.nil?
    fail ArgumentError, "Missing the required parameter 'experiment_id' when calling AgentObservabilityAPI.create_llm_obs_experiment_events"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_experiment_events"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experiments/{experiment_id}/events'.sub('{experiment_id}', CGI.escape(experiment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_experiment_events,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_experiment_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_experiment_with_http_info(body, opts = {}) ⇒ Array<(LLMObsExperimentResponse, Integer, Hash)>

Create an Agent Observability experiment.

Create a new Agent Observability experiment.

Parameters:

  • body (LLMObsExperimentRequest) —

    Create experiment payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsExperimentResponse, Integer, Hash)>) —

    LLMObsExperimentResponse data, response status code and response headers



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 608

def create_llm_obs_experiment_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_experiment".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_experiment")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_experiment"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_experiment ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_experiment"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experiments'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_experiment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_integration_inference(integration, account_id, body, opts = {}) ⇒ Object

Run an LLM inference.

See Also:



747
748
749
750
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 747

def create_llm_obs_integration_inference(integration, , body, opts = {})
  data, _status_code, _headers = create_llm_obs_integration_inference_with_http_info(integration, , body, opts)
  data
end

#create_llm_obs_integration_inference_with_http_info(integration, account_id, body, opts = {}) ⇒ Array<(LLMObsIntegrationInferenceResponse, Integer, Hash)>

Run an LLM inference.

Run an LLM inference request through the specified integration and account, returning the model response and token usage.

Parameters:

Returns:



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 761

def create_llm_obs_integration_inference_with_http_info(integration, , body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_integration_inference".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_integration_inference")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_integration_inference"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_integration_inference ...'
  end
  # verify the required parameter 'integration' is set
  if @api_client.config.client_side_validation && integration.nil?
    fail ArgumentError, "Missing the required parameter 'integration' when calling AgentObservabilityAPI.create_llm_obs_integration_inference"
  end
  # verify enum value
  allowable_values = ['openai', 'amazon_bedrock', 'anthropic', 'azure_openai', 'vertex_ai', 'llmproxy']
  if @api_client.config.client_side_validation && !allowable_values.include?(integration)
    fail ArgumentError, "invalid value for \"integration\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AgentObservabilityAPI.create_llm_obs_integration_inference"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_integration_inference"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/integrations/{integration}/{account_id}/inference'.sub('{integration}', CGI.escape(integration.to_s).gsub('%2F', '/')).sub('{account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsIntegrationInferenceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_integration_inference,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_integration_inference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_project(body, opts = {}) ⇒ Object

Create an Agent Observability project.

See Also:



835
836
837
838
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 835

def create_llm_obs_project(body, opts = {})
  data, _status_code, _headers = create_llm_obs_project_with_http_info(body, opts)
  data
end

#create_llm_obs_project_with_http_info(body, opts = {}) ⇒ Array<(LLMObsProjectResponse, Integer, Hash)>

Create an Agent Observability project.

Create a new Agent Observability project. Returns the existing project if a name conflict occurs.

Parameters:

  • body (LLMObsProjectRequest) —

    Create project payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsProjectResponse, Integer, Hash)>) —

    LLMObsProjectResponse data, response status code and response headers



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 847

def create_llm_obs_project_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_project".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_project")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_project"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_project ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_project"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/projects'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsProjectResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_project,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_prompt(body, opts = {}) ⇒ Object

Create an Agent Observability prompt.

See Also:



908
909
910
911
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 908

def create_llm_obs_prompt(body, opts = {})
  data, _status_code, _headers = create_llm_obs_prompt_with_http_info(body, opts)
  data
end

#create_llm_obs_prompt_version(prompt_id, body, opts = {}) ⇒ Object

Create a new Agent Observability prompt version.

See Also:



981
982
983
984
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 981

def create_llm_obs_prompt_version(prompt_id, body, opts = {})
  data, _status_code, _headers = create_llm_obs_prompt_version_with_http_info(prompt_id, body, opts)
  data
end

#create_llm_obs_prompt_version_with_http_info(prompt_id, body, opts = {}) ⇒ Array<(LLMObsPromptVersionResponse, Integer, Hash)>

Create a new Agent Observability prompt version.

Create a new version of an existing Agent Observability prompt.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • body (LLMObsCreatePromptVersionRequest) —

    Create prompt version payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsPromptVersionResponse, Integer, Hash)>) —

    LLMObsPromptVersionResponse data, response status code and response headers



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 994

def create_llm_obs_prompt_version_with_http_info(prompt_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_prompt_version".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_prompt_version")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_prompt_version"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_prompt_version ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.create_llm_obs_prompt_version"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_prompt_version"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}/versions'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptVersionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_prompt_version,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_prompt_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_llm_obs_prompt_with_http_info(body, opts = {}) ⇒ Array<(LLMObsPromptResponse, Integer, Hash)>

Create an Agent Observability prompt.

Create a new prompt (and its first version) in the Agent Observability prompt registry.

Parameters:

Returns:

  • (Array<(LLMObsPromptResponse, Integer, Hash)>) —

    LLMObsPromptResponse data, response status code and response headers



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 920

def create_llm_obs_prompt_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_llm_obs_prompt".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_llm_obs_prompt")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_llm_obs_prompt"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.create_llm_obs_prompt ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.create_llm_obs_prompt"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_llm_obs_prompt,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#create_llm_obs_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_annotation_queue(queue_id, opts = {}) ⇒ Object

Delete an Agent Observability annotation queue.

See Also:



1059
1060
1061
1062
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1059

def delete_llm_obs_annotation_queue(queue_id, opts = {})
  delete_llm_obs_annotation_queue_with_http_info(queue_id, opts)
  nil
end

#delete_llm_obs_annotation_queue_interactions(queue_id, body, opts = {}) ⇒ Object

Delete annotation queue interactions.

See Also:



1130
1131
1132
1133
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1130

def delete_llm_obs_annotation_queue_interactions(queue_id, body, opts = {})
  delete_llm_obs_annotation_queue_interactions_with_http_info(queue_id, body, opts)
  nil
end

#delete_llm_obs_annotation_queue_interactions_with_http_info(queue_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete annotation queue interactions.

Delete one or more interactions from an annotation queue.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1143

def delete_llm_obs_annotation_queue_interactions_with_http_info(queue_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_annotation_queue_interactions".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_annotation_queue_interactions")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_annotation_queue_interactions"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_annotation_queue_interactions ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.delete_llm_obs_annotation_queue_interactions"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.delete_llm_obs_annotation_queue_interactions"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactions/delete'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_annotation_queue_interactions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_annotation_queue_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_annotation_queue_with_http_info(queue_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an Agent Observability annotation queue.

Delete an annotation queue by its ID.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1071

def delete_llm_obs_annotation_queue_with_http_info(queue_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_annotation_queue".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_annotation_queue")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_annotation_queue"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_annotation_queue ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.delete_llm_obs_annotation_queue"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_annotation_queue,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_annotation_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_annotations(queue_id, body, opts = {}) ⇒ Object

Delete annotations.

See Also:



1208
1209
1210
1211
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1208

def delete_llm_obs_annotations(queue_id, body, opts = {})
  data, _status_code, _headers = delete_llm_obs_annotations_with_http_info(queue_id, body, opts)
  data
end

#delete_llm_obs_annotations_with_http_info(queue_id, body, opts = {}) ⇒ Array<(LLMObsDeleteAnnotationsResponse, Integer, Hash)>

Delete annotations.

Delete one or more annotations from an annotation queue.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • body (LLMObsDeleteAnnotationsRequest) —

    Delete annotations payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1221

def delete_llm_obs_annotations_with_http_info(queue_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_annotations".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_annotations")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_annotations"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_annotations ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.delete_llm_obs_annotations"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.delete_llm_obs_annotations"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotations/delete'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDeleteAnnotationsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_annotations,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_custom_eval_config(eval_name, opts = {}) ⇒ Object

Delete a custom evaluator configuration.

See Also:



1286
1287
1288
1289
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1286

def delete_llm_obs_custom_eval_config(eval_name, opts = {})
  delete_llm_obs_custom_eval_config_with_http_info(eval_name, opts)
  nil
end

#delete_llm_obs_custom_eval_config_with_http_info(eval_name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a custom evaluator configuration.

Delete a custom Agent Observability evaluator configuration by its name.

Parameters:

  • eval_name (String) —

    The name of the custom Agent Observability evaluator configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1298

def delete_llm_obs_custom_eval_config_with_http_info(eval_name, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_custom_eval_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_custom_eval_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_custom_eval_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_custom_eval_config ...'
  end
  # verify the required parameter 'eval_name' is set
  if @api_client.config.client_side_validation && eval_name.nil?
    fail ArgumentError, "Missing the required parameter 'eval_name' when calling AgentObservabilityAPI.delete_llm_obs_custom_eval_config"
  end
  # resource path
  local_var_path = '/api/unstable/llm-obs/config/evaluators/custom/{eval_name}'.sub('{eval_name}', CGI.escape(eval_name.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_custom_eval_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_custom_eval_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_dataset_records(project_id, dataset_id, body, opts = {}) ⇒ Object

Delete Agent Observability dataset records.

See Also:



1357
1358
1359
1360
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1357

def delete_llm_obs_dataset_records(project_id, dataset_id, body, opts = {})
  delete_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts)
  nil
end

#delete_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Agent Observability dataset records.

Delete one or more records from an Agent Observability dataset.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • body (LLMObsDeleteDatasetRecordsRequest) —

    Delete records payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1371

def delete_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_dataset_records".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_dataset_records")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_dataset_records"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_dataset_records ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.delete_llm_obs_dataset_records"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.delete_llm_obs_dataset_records"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.delete_llm_obs_dataset_records"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records/delete'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_dataset_records,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_dataset_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_datasets(project_id, body, opts = {}) ⇒ Object

Delete Agent Observability datasets.

See Also:



1440
1441
1442
1443
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1440

def delete_llm_obs_datasets(project_id, body, opts = {})
  delete_llm_obs_datasets_with_http_info(project_id, body, opts)
  nil
end

#delete_llm_obs_datasets_with_http_info(project_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Agent Observability datasets.

Delete one or more Agent Observability datasets within the specified project.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • body (LLMObsDeleteDatasetsRequest) —

    Delete datasets payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1453

def delete_llm_obs_datasets_with_http_info(project_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_datasets".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_datasets")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_datasets"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_datasets ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.delete_llm_obs_datasets"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.delete_llm_obs_datasets"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/delete'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_datasets,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_datasets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_experiments(body, opts = {}) ⇒ Object

Delete Agent Observability experiments.

See Also:



1518
1519
1520
1521
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1518

def delete_llm_obs_experiments(body, opts = {})
  delete_llm_obs_experiments_with_http_info(body, opts)
  nil
end

#delete_llm_obs_experiments_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Agent Observability experiments.

Delete one or more Agent Observability experiments.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1530

def delete_llm_obs_experiments_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_experiments".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_experiments")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_experiments"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_experiments ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.delete_llm_obs_experiments"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experiments/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_experiments,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_experiments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_patterns_config(config_id, opts = {}) ⇒ Object

Delete a patterns configuration.

See Also:



1591
1592
1593
1594
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1591

def delete_llm_obs_patterns_config(config_id, opts = {})
  delete_llm_obs_patterns_config_with_http_info(config_id, opts)
  nil
end

#delete_llm_obs_patterns_config_with_http_info(config_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a patterns configuration.

Delete a patterns configuration by its ID.

Parameters:

  • config_id (String) —

    The ID of the patterns configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1603

def delete_llm_obs_patterns_config_with_http_info(config_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_patterns_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_patterns_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_patterns_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_patterns_config ...'
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling AgentObservabilityAPI.delete_llm_obs_patterns_config"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-configs/{config_id}'.sub('{config_id}', CGI.escape(config_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_patterns_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_patterns_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_projects(body, opts = {}) ⇒ Object

Delete Agent Observability projects.

See Also:



1662
1663
1664
1665
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1662

def delete_llm_obs_projects(body, opts = {})
  delete_llm_obs_projects_with_http_info(body, opts)
  nil
end

#delete_llm_obs_projects_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Agent Observability projects.

Delete one or more Agent Observability projects.

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1674

def delete_llm_obs_projects_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_projects".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_projects")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_projects"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_projects ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.delete_llm_obs_projects"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/projects/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_projects,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_llm_obs_prompt(prompt_id, opts = {}) ⇒ Object

Delete an Agent Observability prompt.

See Also:



1735
1736
1737
1738
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1735

def delete_llm_obs_prompt(prompt_id, opts = {})
  data, _status_code, _headers = delete_llm_obs_prompt_with_http_info(prompt_id, opts)
  data
end

#delete_llm_obs_prompt_with_http_info(prompt_id, opts = {}) ⇒ Array<(LLMObsDeletedPromptResponse, Integer, Hash)>

Delete an Agent Observability prompt.

Soft-delete an Agent Observability prompt. The prompt's version rows are retained, but they are no longer accessible through the public prompt registry endpoints.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsDeletedPromptResponse, Integer, Hash)>) —

    LLMObsDeletedPromptResponse data, response status code and response headers



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1747

def delete_llm_obs_prompt_with_http_info(prompt_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_llm_obs_prompt".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_llm_obs_prompt")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_llm_obs_prompt"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.delete_llm_obs_prompt ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.delete_llm_obs_prompt"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDeletedPromptResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_llm_obs_prompt,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#delete_llm_obs_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_llm_obs_dataset(project_id, dataset_id, opts = {}) ⇒ Object

Export an Agent Observability dataset.

See Also:



1806
1807
1808
1809
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1806

def export_llm_obs_dataset(project_id, dataset_id, opts = {})
  data, _status_code, _headers = export_llm_obs_dataset_with_http_info(project_id, dataset_id, opts)
  data
end

#export_llm_obs_dataset_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Export an Agent Observability dataset.

Download the contents of a dataset as a CSV file. The download is streamed and includes one row per dataset record.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (LLMObsDatasetExportFormat) —

    Export format for the dataset contents. Only csv is currently supported.

  • :version (Integer) —

    Version of the dataset to export. If omitted, the current version is used. Must be between 0 and the current version of the dataset, inclusive.

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1821

def export_llm_obs_dataset_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.export_llm_obs_dataset".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.export_llm_obs_dataset")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.export_llm_obs_dataset"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.export_llm_obs_dataset ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.export_llm_obs_dataset"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.export_llm_obs_dataset"
  end
  allowable_values = ['csv']
  if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
    fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'version'].nil? && opts[:'version'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"version"]" when calling AgentObservabilityAPI.export_llm_obs_dataset, must be smaller than or equal to 2147483647.'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/export'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :export_llm_obs_dataset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#export_llm_obs_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_annotated_interaction(queue_id, interaction_id, opts = {}) ⇒ Object

Get an annotated queue interaction.

See Also:



1893
1894
1895
1896
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1893

def get_llm_obs_annotated_interaction(queue_id, interaction_id, opts = {})
  data, _status_code, _headers = get_llm_obs_annotated_interaction_with_http_info(queue_id, interaction_id, opts)
  data
end

#get_llm_obs_annotated_interaction_with_http_info(queue_id, interaction_id, opts = {}) ⇒ Array<(LLMObsAnnotatedInteractionResponse, Integer, Hash)>

Get an annotated queue interaction.

Retrieve an interaction, its annotations, and a page of related events from an annotation queue.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • interaction_id (String) —

    The ID of the interaction in the annotation queue.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of events to return. Defaults to 10.

  • :cursor (String) —

    Cursor from the previous response to retrieve the next page of events.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1908

def get_llm_obs_annotated_interaction_with_http_info(queue_id, interaction_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_annotated_interaction".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_annotated_interaction")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_annotated_interaction"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_annotated_interaction ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.get_llm_obs_annotated_interaction"
  end
  # verify the required parameter 'interaction_id' is set
  if @api_client.config.client_side_validation && interaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'interaction_id' when calling AgentObservabilityAPI.get_llm_obs_annotated_interaction"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AgentObservabilityAPI.get_llm_obs_annotated_interaction, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AgentObservabilityAPI.get_llm_obs_annotated_interaction, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/')).sub('{interaction_id}', CGI.escape(interaction_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotatedInteractionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_annotated_interaction,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_annotated_interaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_annotated_interaction_with_pagination(queue_id, interaction_id, opts = {}) {|LLMObsAnnotatedInteractionEvent| ... } ⇒ Object

Get an annotated queue interaction.

Provide a paginated version of #get_llm_obs_annotated_interaction, returning all items.

To use it you need to use a block: get_llm_obs_annotated_interaction_with_pagination { |item| p item }

Yields:



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 1983

def get_llm_obs_annotated_interaction_with_pagination(queue_id, interaction_id, opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "limit", Integer, page_size)
    while true do
        response = get_llm_obs_annotated_interaction(queue_id, interaction_id, opts)
        @api_client.get_attribute_from_path(response, "data.attributes.events").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data.attributes.events").length == 0
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "cursor", String, @api_client.get_attribute_from_path(response, "data.attributes.next_cursor"))
    end
end

#get_llm_obs_annotated_interactions(queue_id, opts = {}) ⇒ Object

Get annotated queue interactions.

See Also:



2000
2001
2002
2003
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2000

def get_llm_obs_annotated_interactions(queue_id, opts = {})
  data, _status_code, _headers = get_llm_obs_annotated_interactions_with_http_info(queue_id, opts)
  data
end

#get_llm_obs_annotated_interactions_by_trace_i_ds(content_ids, opts = {}) ⇒ Object

Get annotated interactions by content IDs.

See Also:



2071
2072
2073
2074
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2071

def get_llm_obs_annotated_interactions_by_trace_i_ds(content_ids, opts = {})
  data, _status_code, _headers = get_llm_obs_annotated_interactions_by_trace_i_ds_with_http_info(content_ids, opts)
  data
end

#get_llm_obs_annotated_interactions_by_trace_i_ds_with_http_info(content_ids, opts = {}) ⇒ Array<(LLMObsAnnotatedInteractionsByTraceResponse, Integer, Hash)>

Get annotated interactions by content IDs.

Returns annotated interactions across all annotation queues for the given content IDs. Results include queue metadata (ID and name) for each interaction.

Parameters:

  • content_ids (Array<String>) —

    One or more content IDs to retrieve annotated interactions for. At least one is required.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Pagination offset. Must be >= 0. Defaults to 0.

  • :limit (Integer) —

    Maximum number of results to return. Must be > 0. Defaults to 100.

Returns:



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2086

def get_llm_obs_annotated_interactions_by_trace_i_ds_with_http_info(content_ids, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_annotated_interactions_by_trace_i_ds".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_annotated_interactions_by_trace_i_ds")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_annotated_interactions_by_trace_i_ds"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_annotated_interactions_by_trace_i_ds ...'
  end
  # verify the required parameter 'content_ids' is set
  if @api_client.config.client_side_validation && content_ids.nil?
    fail ArgumentError, "Missing the required parameter 'content_ids' when calling AgentObservabilityAPI.get_llm_obs_annotated_interactions_by_trace_i_ds"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling AgentObservabilityAPI.get_llm_obs_annotated_interactions_by_trace_i_ds, must be smaller than or equal to 2147483647.'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling AgentObservabilityAPI.get_llm_obs_annotated_interactions_by_trace_i_ds, must be greater than or equal to 0.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AgentObservabilityAPI.get_llm_obs_annotated_interactions_by_trace_i_ds, must be smaller than or equal to 2147483647.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AgentObservabilityAPI.get_llm_obs_annotated_interactions_by_trace_i_ds, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotated-interactions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'contentIds'] = @api_client.build_collection_param(content_ids, :multi)
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotatedInteractionsByTraceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_annotated_interactions_by_trace_i_ds,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_annotated_interactions_by_trace_i_ds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_annotated_interactions_with_http_info(queue_id, opts = {}) ⇒ Array<(LLMObsAnnotatedInteractionsResponse, Integer, Hash)>

Get annotated queue interactions.

Retrieve all interactions (traces and sessions) and their annotations for a given annotation queue.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2012

def get_llm_obs_annotated_interactions_with_http_info(queue_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_annotated_interactions".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_annotated_interactions")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_annotated_interactions"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_annotated_interactions ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.get_llm_obs_annotated_interactions"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotatedInteractionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_annotated_interactions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_annotated_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_annotation_queue_label_schema(queue_id, opts = {}) ⇒ Object

Get annotation queue label schema.

See Also:



2161
2162
2163
2164
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2161

def get_llm_obs_annotation_queue_label_schema(queue_id, opts = {})
  data, _status_code, _headers = get_llm_obs_annotation_queue_label_schema_with_http_info(queue_id, opts)
  data
end

#get_llm_obs_annotation_queue_label_schema_with_http_info(queue_id, opts = {}) ⇒ Array<(LLMObsAnnotationQueueLabelSchemaResponse, Integer, Hash)>

Get annotation queue label schema.

Retrieve the label schema for a given annotation queue.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2173

def get_llm_obs_annotation_queue_label_schema_with_http_info(queue_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_annotation_queue_label_schema".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_annotation_queue_label_schema")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_annotation_queue_label_schema"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_annotation_queue_label_schema ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.get_llm_obs_annotation_queue_label_schema"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationQueueLabelSchemaResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_annotation_queue_label_schema,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_annotation_queue_label_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_custom_eval_config(eval_name, opts = {}) ⇒ Object

Get a custom evaluator configuration.

See Also:



2232
2233
2234
2235
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2232

def get_llm_obs_custom_eval_config(eval_name, opts = {})
  data, _status_code, _headers = get_llm_obs_custom_eval_config_with_http_info(eval_name, opts)
  data
end

#get_llm_obs_custom_eval_config_with_http_info(eval_name, opts = {}) ⇒ Array<(LLMObsCustomEvalConfigResponse, Integer, Hash)>

Get a custom evaluator configuration.

Retrieve a custom Agent Observability evaluator configuration by its name.

Parameters:

  • eval_name (String) —

    The name of the custom Agent Observability evaluator configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2244

def get_llm_obs_custom_eval_config_with_http_info(eval_name, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_custom_eval_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_custom_eval_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_custom_eval_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_custom_eval_config ...'
  end
  # verify the required parameter 'eval_name' is set
  if @api_client.config.client_side_validation && eval_name.nil?
    fail ArgumentError, "Missing the required parameter 'eval_name' when calling AgentObservabilityAPI.get_llm_obs_custom_eval_config"
  end
  # resource path
  local_var_path = '/api/unstable/llm-obs/config/evaluators/custom/{eval_name}'.sub('{eval_name}', CGI.escape(eval_name.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsCustomEvalConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_custom_eval_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_custom_eval_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_dataset_draft_state(project_id, dataset_id, opts = {}) ⇒ Object

Get Agent Observability dataset draft state.

See Also:



2303
2304
2305
2306
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2303

def get_llm_obs_dataset_draft_state(project_id, dataset_id, opts = {})
  data, _status_code, _headers = get_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts)
  data
end

#get_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(LLMObsDatasetDraftStateResponse, Integer, Hash)>

Get Agent Observability dataset draft state.

Retrieve the draft state of a dataset, including whether it is currently locked for editing and which user holds the lock.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2316

def get_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_dataset_draft_state".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_dataset_draft_state")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_dataset_draft_state"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_dataset_draft_state ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.get_llm_obs_dataset_draft_state"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.get_llm_obs_dataset_draft_state"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/draft_state'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetDraftStateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_dataset_draft_state,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_dataset_draft_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_patterns_config(opts = {}) ⇒ Object

Get a patterns configuration.

See Also:



2379
2380
2381
2382
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2379

def get_llm_obs_patterns_config(opts = {})
  data, _status_code, _headers = get_llm_obs_patterns_config_with_http_info(opts)
  data
end

#get_llm_obs_patterns_config_with_http_info(opts = {}) ⇒ Array<(LLMObsPatternsConfigResponse, Integer, Hash)>

Get a patterns configuration.

Retrieve the patterns configuration for the organization.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2390

def get_llm_obs_patterns_config_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_patterns_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_patterns_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_patterns_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_patterns_config ...'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-configs/latest'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_patterns_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_patterns_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_patterns_run_status(config_id, opts = {}) ⇒ Object

Get patterns run status.

See Also:



2445
2446
2447
2448
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2445

def get_llm_obs_patterns_run_status(config_id, opts = {})
  data, _status_code, _headers = get_llm_obs_patterns_run_status_with_http_info(config_id, opts)
  data
end

#get_llm_obs_patterns_run_status_with_http_info(config_id, opts = {}) ⇒ Array<(LLMObsPatternsRunStatusResponse, Integer, Hash)>

Get patterns run status.

Retrieve the status and step-by-step progress of the current or most recent patterns run for a configuration.

Parameters:

  • config_id (String) —

    The ID of the patterns configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2458

def get_llm_obs_patterns_run_status_with_http_info(config_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_patterns_run_status".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_patterns_run_status")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_patterns_run_status"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_patterns_run_status ...'
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling AgentObservabilityAPI.get_llm_obs_patterns_run_status"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-runs/status'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'config_id'] = config_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsRunStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_patterns_run_status,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_patterns_run_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_prompt(prompt_id, opts = {}) ⇒ Object

Get an Agent Observability prompt.

See Also:



2518
2519
2520
2521
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2518

def get_llm_obs_prompt(prompt_id, opts = {})
  data, _status_code, _headers = get_llm_obs_prompt_with_http_info(prompt_id, opts)
  data
end

#get_llm_obs_prompt_version(prompt_id, version, opts = {}) ⇒ Object

Get a specific Agent Observability prompt version.

See Also:



2591
2592
2593
2594
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2591

def get_llm_obs_prompt_version(prompt_id, version, opts = {})
  data, _status_code, _headers = get_llm_obs_prompt_version_with_http_info(prompt_id, version, opts)
  data
end

#get_llm_obs_prompt_version_with_http_info(prompt_id, version, opts = {}) ⇒ Array<(LLMObsPromptVersionResponse, Integer, Hash)>

Get a specific Agent Observability prompt version.

Get the full template of a single, specific version of an Agent Observability prompt.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • version (Integer) —

    The version number of the Agent Observability prompt.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsPromptVersionResponse, Integer, Hash)>) —

    LLMObsPromptVersionResponse data, response status code and response headers



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2604

def get_llm_obs_prompt_version_with_http_info(prompt_id, version, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_prompt_version".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_prompt_version")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_prompt_version"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_prompt_version ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.get_llm_obs_prompt_version"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling AgentObservabilityAPI.get_llm_obs_prompt_version"
  end
  if @api_client.config.client_side_validation && version < 1
    fail ArgumentError, 'invalid value for "version" when calling AgentObservabilityAPI.get_llm_obs_prompt_version, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version}'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/')).sub('{version}', CGI.escape(version.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptVersionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_prompt_version,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_prompt_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_llm_obs_prompt_with_http_info(prompt_id, opts = {}) ⇒ Array<(LLMObsPromptSDKResponse, Integer, Hash)>

Get an Agent Observability prompt.

Get the latest version of an Agent Observability prompt by prompt ID.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :label (String) —

    Deprecated. Optional label of the prompt version to return. Do not use this parameter for new integrations. If omitted, the latest version is returned. If the prompt has no labels, the latest version is returned even when a label is requested. If the prompt has labels but none match the requested label, a 404 response is returned.

Returns:

  • (Array<(LLMObsPromptSDKResponse, Integer, Hash)>) —

    LLMObsPromptSDKResponse data, response status code and response headers



2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2531

def get_llm_obs_prompt_with_http_info(prompt_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_llm_obs_prompt".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_llm_obs_prompt")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_llm_obs_prompt"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.get_llm_obs_prompt ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.get_llm_obs_prompt"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptSDKResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_llm_obs_prompt,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#get_llm_obs_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_annotation_queues(opts = {}) ⇒ Object

List Agent Observability annotation queues.

See Also:



2670
2671
2672
2673
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2670

def list_llm_obs_annotation_queues(opts = {})
  data, _status_code, _headers = list_llm_obs_annotation_queues_with_http_info(opts)
  data
end

#list_llm_obs_annotation_queues_with_http_info(opts = {}) ⇒ Array<(LLMObsAnnotationQueuesResponse, Integer, Hash)>

List Agent Observability annotation queues.

List annotation queues. Optionally filter by project ID or queue IDs. These parameters are mutually exclusive. If neither is provided, all queues in the organization are returned.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :project_id (String) —

    Filter annotation queues by project ID. Cannot be used together with queueIds.

  • :queue_ids (Array<String>) —

    Filter annotation queues by queue IDs (comma-separated). Cannot be used together with projectId.

Returns:



2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2684

def list_llm_obs_annotation_queues_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_annotation_queues".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_annotation_queues")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_annotation_queues"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_annotation_queues ...'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'queueIds'] = @api_client.build_collection_param(opts[:'queue_ids'], :multi) if !opts[:'queue_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationQueuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_annotation_queues,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_annotation_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_custom_eval_configs(opts = {}) ⇒ Object

List custom evaluator configurations.

See Also:



2742
2743
2744
2745
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2742

def list_llm_obs_custom_eval_configs(opts = {})
  data, _status_code, _headers = list_llm_obs_custom_eval_configs_with_http_info(opts)
  data
end

#list_llm_obs_custom_eval_configs_with_http_info(opts = {}) ⇒ Array<(LLMObsCustomEvalConfigListResponse, Integer, Hash)>

List custom evaluator configurations.

List all custom Agent Observability evaluator configurations for the organization.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2753

def list_llm_obs_custom_eval_configs_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_custom_eval_configs".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_custom_eval_configs")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_custom_eval_configs"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_custom_eval_configs ...'
  end
  # resource path
  local_var_path = '/api/unstable/llm-obs/config/evaluators/custom'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsCustomEvalConfigListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_custom_eval_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_custom_eval_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_dataset_records(project_id, dataset_id, opts = {}) ⇒ Object

List Agent Observability dataset records.

See Also:



2808
2809
2810
2811
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2808

def list_llm_obs_dataset_records(project_id, dataset_id, opts = {})
  data, _status_code, _headers = list_llm_obs_dataset_records_with_http_info(project_id, dataset_id, opts)
  data
end

#list_llm_obs_dataset_records_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(LLMObsDatasetRecordsListResponse, Integer, Hash)>

List Agent Observability dataset records.

List all records in an Agent Observability dataset, sorted by creation date, newest first.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_version (Integer) —

    Retrieve records from a specific dataset version. Defaults to the current version.

  • :page_cursor (String) —

    Use the Pagination cursor to retrieve the next page of results.

  • :page_limit (Integer) —

    Maximum number of results to return per page.

Returns:



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2824

def list_llm_obs_dataset_records_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_dataset_records".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_dataset_records")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_dataset_records"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_dataset_records ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.list_llm_obs_dataset_records"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.list_llm_obs_dataset_records"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[version]'] = opts[:'filter_version'] if !opts[:'filter_version'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetRecordsListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_dataset_records,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_dataset_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_dataset_versions(project_id, dataset_id, opts = {}) ⇒ Object

List Agent Observability dataset versions.

See Also:



2969
2970
2971
2972
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2969

def list_llm_obs_dataset_versions(project_id, dataset_id, opts = {})
  data, _status_code, _headers = list_llm_obs_dataset_versions_with_http_info(project_id, dataset_id, opts)
  data
end

#list_llm_obs_dataset_versions_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(LLMObsDatasetVersionsResponse, Integer, Hash)>

List Agent Observability dataset versions.

List the active versions of a dataset. A version is created each time a dataset is referenced by an experiment run.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2982

def list_llm_obs_dataset_versions_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_dataset_versions".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_dataset_versions")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_dataset_versions"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_dataset_versions ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.list_llm_obs_dataset_versions"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.list_llm_obs_dataset_versions"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/versions'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetVersionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_dataset_versions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_dataset_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_datasets(project_id, opts = {}) ⇒ Object

List Agent Observability datasets.

See Also:



2890
2891
2892
2893
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2890

def list_llm_obs_datasets(project_id, opts = {})
  data, _status_code, _headers = list_llm_obs_datasets_with_http_info(project_id, opts)
  data
end

#list_llm_obs_datasets_with_http_info(project_id, opts = {}) ⇒ Array<(LLMObsDatasetsResponse, Integer, Hash)>

List Agent Observability datasets.

List all Agent Observability datasets for a project, sorted by creation date, newest first.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_name (String) —

    Filter datasets by name.

  • :filter_id (String) —

    Filter datasets by dataset ID.

  • :page_cursor (String) —

    Use the Pagination cursor to retrieve the next page of results.

  • :page_limit (Integer) —

    Maximum number of results to return per page.

Returns:

  • (Array<(LLMObsDatasetsResponse, Integer, Hash)>) —

    LLMObsDatasetsResponse data, response status code and response headers



2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 2906

def list_llm_obs_datasets_with_http_info(project_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_datasets".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_datasets")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_datasets"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_datasets ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.list_llm_obs_datasets"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'filter[id]'] = opts[:'filter_id'] if !opts[:'filter_id'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_datasets,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_datasets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_experiment_events(experiment_id, opts = {}) ⇒ Object

List events for an Agent Observability experiment.

See Also:



3045
3046
3047
3048
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3045

def list_llm_obs_experiment_events(experiment_id, opts = {})
  data, _status_code, _headers = list_llm_obs_experiment_events_with_http_info(experiment_id, opts)
  data
end

#list_llm_obs_experiment_events_v1(experiment_id, opts = {}) ⇒ Object

List Agent Observability experiment spans (v1).

See Also:



3120
3121
3122
3123
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3120

def list_llm_obs_experiment_events_v1(experiment_id, opts = {})
  data, _status_code, _headers = list_llm_obs_experiment_events_v1_with_http_info(experiment_id, opts)
  data
end

#list_llm_obs_experiment_events_v1_with_http_info(experiment_id, opts = {}) ⇒ Array<(LLMObsExperimentSpansResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

List Agent Observability experiment spans (v1).

Retrieve spans with their evaluation metrics for a given experiment. Returns spans only, with no summary metrics and no pagination. Deprecated in favor of ListLLMObsExperimentEventsV3.

Parameters:

  • experiment_id (String) —

    The ID of the Agent Observability experiment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3134

def list_llm_obs_experiment_events_v1_with_http_info(experiment_id, opts = {})
  warn "[DEPRECATION] `ListLLMObsExperimentEventsV1` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_experiment_events_v1".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_experiment_events_v1")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_experiment_events_v1"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_experiment_events_v1 ...'
  end
  # verify the required parameter 'experiment_id' is set
  if @api_client.config.client_side_validation && experiment_id.nil?
    fail ArgumentError, "Missing the required parameter 'experiment_id' when calling AgentObservabilityAPI.list_llm_obs_experiment_events_v1"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experiments/{experiment_id}/events'.sub('{experiment_id}', CGI.escape(experiment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentSpansResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_experiment_events_v1,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_experiment_events_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_experiment_events_v2(experiment_id, opts = {}) ⇒ Object

List Agent Observability experiment events (v2).

See Also:



3194
3195
3196
3197
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3194

def list_llm_obs_experiment_events_v2(experiment_id, opts = {})
  data, _status_code, _headers = list_llm_obs_experiment_events_v2_with_http_info(experiment_id, opts)
  data
end

#list_llm_obs_experiment_events_v2_with_http_info(experiment_id, opts = {}) ⇒ Array<(LLMObsExperimentEventsV2Response, Integer, Hash)>

Deprecated.

This API is deprecated.

List Agent Observability experiment events (v2).

Retrieve spans and experiment-level summary metrics for a given experiment. Returns the full events payload without pagination. Deprecated: use ListLLMObsExperimentEventsV3 instead.

Parameters:

  • experiment_id (String) —

    The ID of the Agent Observability experiment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3208

def list_llm_obs_experiment_events_v2_with_http_info(experiment_id, opts = {})
  warn "[DEPRECATION] `ListLLMObsExperimentEventsV2` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_experiment_events_v2".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_experiment_events_v2")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_experiment_events_v2"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_experiment_events_v2 ...'
  end
  # verify the required parameter 'experiment_id' is set
  if @api_client.config.client_side_validation && experiment_id.nil?
    fail ArgumentError, "Missing the required parameter 'experiment_id' when calling AgentObservabilityAPI.list_llm_obs_experiment_events_v2"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v2/experiments/{experiment_id}/events'.sub('{experiment_id}', CGI.escape(experiment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentEventsV2Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_experiment_events_v2,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_experiment_events_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_experiment_events_with_http_info(experiment_id, opts = {}) ⇒ Array<(LLMObsExperimentEventsV2Response, Integer, Hash)>

List events for an Agent Observability experiment.

Retrieve spans and experiment-level summary metrics for a given experiment with cursor-based pagination.

Parameters:

  • experiment_id (String) —

    The ID of the Agent Observability experiment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_limit (Integer) —

    Maximum number of spans to return per page. Defaults to 5000.

  • :page_cursor (String) —

    Opaque cursor from a previous response to fetch the next page of results.

Returns:



3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3059

def list_llm_obs_experiment_events_with_http_info(experiment_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_experiment_events".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_experiment_events")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_experiment_events"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_experiment_events ...'
  end
  # verify the required parameter 'experiment_id' is set
  if @api_client.config.client_side_validation && experiment_id.nil?
    fail ArgumentError, "Missing the required parameter 'experiment_id' when calling AgentObservabilityAPI.list_llm_obs_experiment_events"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v3/experiments/{experiment_id}/events'.sub('{experiment_id}', CGI.escape(experiment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentEventsV2Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_experiment_events,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_experiment_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_experiments(opts = {}) ⇒ Object

List Agent Observability experiments.

See Also:



3268
3269
3270
3271
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3268

def list_llm_obs_experiments(opts = {})
  data, _status_code, _headers = list_llm_obs_experiments_with_http_info(opts)
  data
end

#list_llm_obs_experiments_with_http_info(opts = {}) ⇒ Array<(LLMObsExperimentsResponse, Integer, Hash)>

List Agent Observability experiments.

List all Agent Observability experiments sorted by creation date, newest first.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_project_id (String) —

    Filter experiments by project ID. Required if filter[dataset_id] is not provided.

  • :filter_dataset_id (String) —

    Filter experiments by dataset ID.

  • :filter_id (String) —

    Filter experiments by experiment ID. Can be specified multiple times.

  • :filter_name (String) —

    Filter experiments by their exact run name.

  • :filter_experiment (String) —

    Filter by logical experiment name. This is the name field set when creating an experiment through POST /experiments. Returns all experiment runs that share the same name, enabling cross-commit and cross-branch comparisons.

  • :filter_metadata (String) —

    Filter by JSONB metadata containment. Provide a JSON object string where experiments whose metadata contains all specified key-value pairs are returned. For example: {"commit":"abc123","branch":"main"}.

  • :filter_parent_experiment_id (String) —

    Filter experiments by the ID of their parent (baseline) experiment. Returns all experiments that were run against the given baseline. Can be specified multiple times.

  • :filter_is_deleted (Boolean) —

    When true, return only soft-deleted experiments. Defaults to false.

  • :include_user_data (Boolean) —

    When true, enrich each experiment with its author's user data in the author field.

  • :include_dataset_names (Boolean) —

    When true, enrich each experiment with its dataset name in the dataset_name field.

  • :page_cursor (String) —

    Use the pagination cursor returned in meta.after to retrieve the next page of results.

  • :page_limit (Integer) —

    Maximum number of results to return per page. Values above 5000 are clamped to 5000. Defaults to 5000.

Returns:

  • (Array<(LLMObsExperimentsResponse, Integer, Hash)>) —

    LLMObsExperimentsResponse data, response status code and response headers



3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3291

def list_llm_obs_experiments_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_experiments".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_experiments")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_experiments"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_experiments ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 5000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling AgentObservabilityAPI.list_llm_obs_experiments, must be smaller than or equal to 5000.'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experiments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[project_id]'] = opts[:'filter_project_id'] if !opts[:'filter_project_id'].nil?
  query_params[:'filter[dataset_id]'] = opts[:'filter_dataset_id'] if !opts[:'filter_dataset_id'].nil?
  query_params[:'filter[id]'] = opts[:'filter_id'] if !opts[:'filter_id'].nil?
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'filter[experiment]'] = opts[:'filter_experiment'] if !opts[:'filter_experiment'].nil?
  query_params[:'filter[metadata]'] = opts[:'filter_metadata'] if !opts[:'filter_metadata'].nil?
  query_params[:'filter[parent_experiment_id]'] = opts[:'filter_parent_experiment_id'] if !opts[:'filter_parent_experiment_id'].nil?
  query_params[:'filter[is_deleted]'] = opts[:'filter_is_deleted'] if !opts[:'filter_is_deleted'].nil?
  query_params[:'include[user_data]'] = opts[:'include_user_data'] if !opts[:'include_user_data'].nil?
  query_params[:'include[dataset_names]'] = opts[:'include_dataset_names'] if !opts[:'include_dataset_names'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_experiments,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_experiments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_integration_accounts(integration, opts = {}) ⇒ Object

List LLM integration accounts.

See Also:



3361
3362
3363
3364
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3361

def list_llm_obs_integration_accounts(integration, opts = {})
  data, _status_code, _headers = list_llm_obs_integration_accounts_with_http_info(integration, opts)
  data
end

#list_llm_obs_integration_accounts_with_http_info(integration, opts = {}) ⇒ Array<(Array<LLMObsIntegrationAccount>, Integer, Hash)>

List LLM integration accounts.

Retrieve the list of configured accounts for the specified LLM provider integration.

Parameters:

  • integration (LLMObsIntegrationName) —

    The name of the LLM integration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3373

def list_llm_obs_integration_accounts_with_http_info(integration, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_integration_accounts".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_integration_accounts")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_integration_accounts"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_integration_accounts ...'
  end
  # verify the required parameter 'integration' is set
  if @api_client.config.client_side_validation && integration.nil?
    fail ArgumentError, "Missing the required parameter 'integration' when calling AgentObservabilityAPI.list_llm_obs_integration_accounts"
  end
  # verify enum value
  allowable_values = ['openai', 'amazon_bedrock', 'anthropic', 'azure_openai', 'vertex_ai', 'llmproxy']
  if @api_client.config.client_side_validation && !allowable_values.include?(integration)
    fail ArgumentError, "invalid value for \"integration\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/integrations/{integration}/accounts'.sub('{integration}', CGI.escape(integration.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LLMObsIntegrationAccount>'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_integration_accounts,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_integration_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_integration_models(integration, account_id, opts = {}) ⇒ Object

List LLM integration models.

See Also:



3437
3438
3439
3440
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3437

def list_llm_obs_integration_models(integration, , opts = {})
  data, _status_code, _headers = list_llm_obs_integration_models_with_http_info(integration, , opts)
  data
end

#list_llm_obs_integration_models_with_http_info(integration, account_id, opts = {}) ⇒ Array<(Array<LLMObsIntegrationModel>, Integer, Hash)>

List LLM integration models.

Retrieve the list of models available for the specified LLM provider integration and account.

Parameters:

  • integration (LLMObsIntegrationName) —

    The name of the LLM integration.

  • account_id (String) —

    The ID of the integration account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<LLMObsIntegrationModel>, Integer, Hash)>) —

    Array data, response status code and response headers



3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3450

def list_llm_obs_integration_models_with_http_info(integration, , opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_integration_models".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_integration_models")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_integration_models"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_integration_models ...'
  end
  # verify the required parameter 'integration' is set
  if @api_client.config.client_side_validation && integration.nil?
    fail ArgumentError, "Missing the required parameter 'integration' when calling AgentObservabilityAPI.list_llm_obs_integration_models"
  end
  # verify enum value
  allowable_values = ['openai', 'amazon_bedrock', 'anthropic', 'azure_openai', 'vertex_ai', 'llmproxy']
  if @api_client.config.client_side_validation && !allowable_values.include?(integration)
    fail ArgumentError, "invalid value for \"integration\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AgentObservabilityAPI.list_llm_obs_integration_models"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/integrations/{integration}/{account_id}/models'.sub('{integration}', CGI.escape(integration.to_s).gsub('%2F', '/')).sub('{account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LLMObsIntegrationModel>'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_integration_models,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_integration_models\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_patterns_clustered_points(topic_id, opts = {}) ⇒ Object

List patterns clustered points.

See Also:



3518
3519
3520
3521
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3518

def list_llm_obs_patterns_clustered_points(topic_id, opts = {})
  data, _status_code, _headers = list_llm_obs_patterns_clustered_points_with_http_info(topic_id, opts)
  data
end

#list_llm_obs_patterns_clustered_points_with_http_info(topic_id, opts = {}) ⇒ Array<(LLMObsPatternsClusteredPointsResponse, Integer, Hash)>

List patterns clustered points.

List the data points grouped into a topic. For a parent topic, points from all of its leaf topics are returned.

Parameters:

  • topic_id (String) —

    The ID of the topic to retrieve clustered points for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Maximum number of clustered points to return per page.

  • :page_token (String) —

    Pagination token to retrieve the next page of clustered points.

Returns:



3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3533

def list_llm_obs_patterns_clustered_points_with_http_info(topic_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_patterns_clustered_points".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_patterns_clustered_points")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_patterns_clustered_points"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_patterns_clustered_points ...'
  end
  # verify the required parameter 'topic_id' is set
  if @api_client.config.client_side_validation && topic_id.nil?
    fail ArgumentError, "Missing the required parameter 'topic_id' when calling AgentObservabilityAPI.list_llm_obs_patterns_clustered_points"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-clustered-points'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'topic_id'] = topic_id
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsClusteredPointsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_patterns_clustered_points,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_patterns_clustered_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_patterns_configs(opts = {}) ⇒ Object

List patterns configurations.

See Also:



3595
3596
3597
3598
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3595

def list_llm_obs_patterns_configs(opts = {})
  data, _status_code, _headers = list_llm_obs_patterns_configs_with_http_info(opts)
  data
end

#list_llm_obs_patterns_configs_with_http_info(opts = {}) ⇒ Array<(LLMObsPatternsConfigsResponse, Integer, Hash)>

List patterns configurations.

List all patterns configurations for the organization.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3606

def list_llm_obs_patterns_configs_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_patterns_configs".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_patterns_configs")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_patterns_configs"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_patterns_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-configs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsConfigsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_patterns_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_patterns_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_patterns_runs(config_id, opts = {}) ⇒ Object

List patterns runs.

See Also:



3661
3662
3663
3664
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3661

def list_llm_obs_patterns_runs(config_id, opts = {})
  data, _status_code, _headers = list_llm_obs_patterns_runs_with_http_info(config_id, opts)
  data
end

#list_llm_obs_patterns_runs_with_http_info(config_id, opts = {}) ⇒ Array<(LLMObsPatternsRunsResponse, Integer, Hash)>

List patterns runs.

List the completed patterns runs for a configuration.

Parameters:

  • config_id (String) —

    The ID of the patterns configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsPatternsRunsResponse, Integer, Hash)>) —

    LLMObsPatternsRunsResponse data, response status code and response headers



3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3673

def list_llm_obs_patterns_runs_with_http_info(config_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_patterns_runs".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_patterns_runs")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_patterns_runs"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_patterns_runs ...'
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling AgentObservabilityAPI.list_llm_obs_patterns_runs"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-runs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'config_id'] = config_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsRunsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_patterns_runs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_patterns_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_patterns_topics(config_id, opts = {}) ⇒ Object

List patterns topics.

See Also:



3733
3734
3735
3736
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3733

def list_llm_obs_patterns_topics(config_id, opts = {})
  data, _status_code, _headers = list_llm_obs_patterns_topics_with_http_info(config_id, opts)
  data
end

#list_llm_obs_patterns_topics_with_clustered_points(config_id, opts = {}) ⇒ Object

List patterns topics with clustered points.

See Also:



3808
3809
3810
3811
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3808

def list_llm_obs_patterns_topics_with_clustered_points(config_id, opts = {})
  data, _status_code, _headers = list_llm_obs_patterns_topics_with_clustered_points_with_http_info(config_id, opts)
  data
end

#list_llm_obs_patterns_topics_with_clustered_points_with_http_info(config_id, opts = {}) ⇒ Array<(LLMObsPatternsTopicsWithClusteredPointsResponse, Integer, Hash)>

List patterns topics with clustered points.

List the topics discovered by a patterns run, with the clustered points attached inline to each leaf topic. When no run is specified, the most recent completed run is used.

Parameters:

  • config_id (String) —

    The ID of the patterns configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :run_id (String) —

    The ID of a specific patterns run. Defaults to the most recent completed run.

  • :include_metrics (Boolean) —

    When true, enrich each clustered point with span metrics such as status, duration, token counts, estimated cost, and evaluations.

Returns:



3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3824

def list_llm_obs_patterns_topics_with_clustered_points_with_http_info(config_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_patterns_topics_with_clustered_points".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_patterns_topics_with_clustered_points")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_patterns_topics_with_clustered_points"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_patterns_topics_with_clustered_points ...'
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling AgentObservabilityAPI.list_llm_obs_patterns_topics_with_clustered_points"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-topics/with-cluster-points'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'config_id'] = config_id
  query_params[:'run_id'] = opts[:'run_id'] if !opts[:'run_id'].nil?
  query_params[:'include_metrics'] = opts[:'include_metrics'] if !opts[:'include_metrics'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsTopicsWithClusteredPointsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_patterns_topics_with_clustered_points,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_patterns_topics_with_clustered_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_patterns_topics_with_http_info(config_id, opts = {}) ⇒ Array<(LLMObsPatternsTopicsResponse, Integer, Hash)>

List patterns topics.

List the topics discovered by a patterns run. When no run is specified, the most recent completed run is used.

Parameters:

  • config_id (String) —

    The ID of the patterns configuration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :run_id (String) —

    The ID of a specific patterns run. Defaults to the most recent completed run.

Returns:



3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3747

def list_llm_obs_patterns_topics_with_http_info(config_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_patterns_topics".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_patterns_topics")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_patterns_topics"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_patterns_topics ...'
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling AgentObservabilityAPI.list_llm_obs_patterns_topics"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-topics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'config_id'] = config_id
  query_params[:'run_id'] = opts[:'run_id'] if !opts[:'run_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsTopicsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_patterns_topics,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_patterns_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_projects(opts = {}) ⇒ Object

List Agent Observability projects.

See Also:



3886
3887
3888
3889
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3886

def list_llm_obs_projects(opts = {})
  data, _status_code, _headers = list_llm_obs_projects_with_http_info(opts)
  data
end

#list_llm_obs_projects_with_http_info(opts = {}) ⇒ Array<(LLMObsProjectsResponse, Integer, Hash)>

List Agent Observability projects.

List all Agent Observability projects sorted by creation date, newest first.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_id (String) —

    Filter projects by project ID.

  • :filter_name (String) —

    Filter projects by name.

  • :page_cursor (String) —

    Use the Pagination cursor to retrieve the next page of results.

  • :page_limit (Integer) —

    Maximum number of results to return per page.

Returns:

  • (Array<(LLMObsProjectsResponse, Integer, Hash)>) —

    LLMObsProjectsResponse data, response status code and response headers



3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3901

def list_llm_obs_projects_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_projects".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_projects")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_projects"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_projects ...'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/projects'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[id]'] = opts[:'filter_id'] if !opts[:'filter_id'].nil?
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsProjectsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_projects,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_prompt_versions(prompt_id, opts = {}) ⇒ Object

List versions of an Agent Observability prompt.

See Also:



4028
4029
4030
4031
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4028

def list_llm_obs_prompt_versions(prompt_id, opts = {})
  data, _status_code, _headers = list_llm_obs_prompt_versions_with_http_info(prompt_id, opts)
  data
end

#list_llm_obs_prompt_versions_with_http_info(prompt_id, opts = {}) ⇒ Array<(LLMObsPromptVersionsResponse, Integer, Hash)>

List versions of an Agent Observability prompt.

List all versions of an Agent Observability prompt, ordered newest to oldest. If the prompt does not exist, is not registered, or is archived, the response contains an empty list.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4040

def list_llm_obs_prompt_versions_with_http_info(prompt_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_prompt_versions".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_prompt_versions")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_prompt_versions"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_prompt_versions ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.list_llm_obs_prompt_versions"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}/versions'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptVersionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_prompt_versions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_prompt_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_prompts(opts = {}) ⇒ Object

List Agent Observability prompts.

See Also:



3960
3961
3962
3963
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3960

def list_llm_obs_prompts(opts = {})
  data, _status_code, _headers = list_llm_obs_prompts_with_http_info(opts)
  data
end

#list_llm_obs_prompts_with_http_info(opts = {}) ⇒ Array<(LLMObsPromptsResponse, Integer, Hash)>

List Agent Observability prompts.

List all Agent Observability prompts in the prompt registry for the organization.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_prompt_id (String) —

    Optional filter for prompts by prompt ID.

Returns:

  • (Array<(LLMObsPromptsResponse, Integer, Hash)>) —

    LLMObsPromptsResponse data, response status code and response headers



3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 3972

def list_llm_obs_prompts_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_prompts".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_prompts")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_prompts"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_prompts ...'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[prompt_id]'] = opts[:'filter_prompt_id'] if !opts[:'filter_prompt_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_prompts,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_spans(opts = {}) ⇒ Object

List Agent Observability spans.

See Also:



4099
4100
4101
4102
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4099

def list_llm_obs_spans(opts = {})
  data, _status_code, _headers = list_llm_obs_spans_with_http_info(opts)
  data
end

#list_llm_obs_spans_with_http_info(opts = {}) ⇒ Array<(LLMObsSpansResponse, Integer, Hash)>

List Agent Observability spans.

List Agent Observability spans matching the specified filters.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_from (String) —

    Start of the time range. Accepts ISO 8601 or relative format (e.g., now-15m). Defaults to now-15m.

  • :filter_to (String) —

    End of the time range. Accepts ISO 8601 or relative format. Defaults to now.

  • :filter_query (String) —

    Search query using Agent Observability query syntax. Supports attribute filters using the field:value syntax (e.g. session_id, trace_id, ml_app, meta.span.kind). When provided, structured field filters (filter[span_id], filter[trace_id], etc.) are ignored.

  • :filter_span_id (String) —

    Filter by exact span ID.

  • :filter_trace_id (String) —

    Filter by exact trace ID.

  • :filter_span_kind (String) —

    Filter by span kind (e.g., llm, agent, tool, task, workflow).

  • :filter_span_name (String) —

    Filter by span name.

  • :filter_ml_app (String) —

    Filter by ML application name.

  • :page_limit (Integer) —

    Maximum number of spans to return. Defaults to 10.

  • :page_cursor (String) —

    Cursor from the previous response to retrieve the next page.

  • :sort (String) —

    Sort order for the results.

  • :include_attachments (Boolean) —

    Whether to include attachment data in the response. Defaults to true.

Returns:

  • (Array<(LLMObsSpansResponse, Integer, Hash)>) —

    LLMObsSpansResponse data, response status code and response headers



4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4122

def list_llm_obs_spans_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_llm_obs_spans".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_llm_obs_spans")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_llm_obs_spans"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.list_llm_obs_spans ...'
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/spans/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil?
  query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil?
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[span_id]'] = opts[:'filter_span_id'] if !opts[:'filter_span_id'].nil?
  query_params[:'filter[trace_id]'] = opts[:'filter_trace_id'] if !opts[:'filter_trace_id'].nil?
  query_params[:'filter[span_kind]'] = opts[:'filter_span_kind'] if !opts[:'filter_span_kind'].nil?
  query_params[:'filter[span_name]'] = opts[:'filter_span_name'] if !opts[:'filter_span_name'].nil?
  query_params[:'filter[ml_app]'] = opts[:'filter_ml_app'] if !opts[:'filter_ml_app'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'include_attachments'] = opts[:'include_attachments'] if !opts[:'include_attachments'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsSpansResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_llm_obs_spans,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#list_llm_obs_spans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lock_llm_obs_dataset_draft_state(project_id, dataset_id, opts = {}) ⇒ Object

Lock Agent Observability dataset draft state.

See Also:



4189
4190
4191
4192
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4189

def lock_llm_obs_dataset_draft_state(project_id, dataset_id, opts = {})
  data, _status_code, _headers = lock_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts)
  data
end

#lock_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(LLMObsDatasetDraftStateResponse, Integer, Hash)>

Lock Agent Observability dataset draft state.

Acquire the draft lock on a dataset for the calling user. The lock prevents other users from concurrently editing the dataset draft.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4202

def lock_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.lock_llm_obs_dataset_draft_state".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.lock_llm_obs_dataset_draft_state")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.lock_llm_obs_dataset_draft_state"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.lock_llm_obs_dataset_draft_state ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.lock_llm_obs_dataset_draft_state"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.lock_llm_obs_dataset_draft_state"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/draft_state/lock'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetDraftStateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :lock_llm_obs_dataset_draft_state,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#lock_llm_obs_dataset_draft_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#restore_llm_obs_dataset_version(project_id, dataset_id, body, opts = {}) ⇒ Object

Restore an Agent Observability dataset version.

See Also:



4265
4266
4267
4268
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4265

def restore_llm_obs_dataset_version(project_id, dataset_id, body, opts = {})
  restore_llm_obs_dataset_version_with_http_info(project_id, dataset_id, body, opts)
  nil
end

#restore_llm_obs_dataset_version_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Restore an Agent Observability dataset version.

Restore a dataset to a previous version. The dataset's current version is bumped, and its records are replaced with the records from the specified prior version.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • body (LLMObsDatasetRestoreVersionRequest) —

    Restore dataset version payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4279

def restore_llm_obs_dataset_version_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.restore_llm_obs_dataset_version".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.restore_llm_obs_dataset_version")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.restore_llm_obs_dataset_version"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.restore_llm_obs_dataset_version ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.restore_llm_obs_dataset_version"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.restore_llm_obs_dataset_version"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.restore_llm_obs_dataset_version"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/restore'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :restore_llm_obs_dataset_version,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#restore_llm_obs_dataset_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_llm_obs_experimentation(body, opts = {}) ⇒ Object

Search Agent Observability experimentation.

See Also:



4348
4349
4350
4351
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4348

def search_llm_obs_experimentation(body, opts = {})
  data, _status_code, _headers = search_llm_obs_experimentation_with_http_info(body, opts)
  data
end

#search_llm_obs_experimentation_with_http_info(body, opts = {}) ⇒ Array<(LLMObsExperimentationSearchResponse, Integer, Hash)>

Search Agent Observability experimentation.

Search across Agent Observability experimentation entities — projects, datasets, dataset records, experiments, and experiment runs — using cursor-based pagination.

The filter.scope field controls which entity types are returned. At least one valid scope must be provided.

Returns 200 OK when all results fit in a single page. Returns 206 Partial Content with a cursor in meta.after when additional pages are available.

Parameters:

Returns:



4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4364

def search_llm_obs_experimentation_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.search_llm_obs_experimentation".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.search_llm_obs_experimentation")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.search_llm_obs_experimentation"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.search_llm_obs_experimentation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.search_llm_obs_experimentation"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experimentation/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentationSearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :search_llm_obs_experimentation,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#search_llm_obs_experimentation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_llm_obs_spans(body, opts = {}) ⇒ Object

Search Agent Observability spans.

See Also:



4425
4426
4427
4428
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4425

def search_llm_obs_spans(body, opts = {})
  data, _status_code, _headers = search_llm_obs_spans_with_http_info(body, opts)
  data
end

#search_llm_obs_spans_with_http_info(body, opts = {}) ⇒ Array<(LLMObsSpansResponse, Integer, Hash)>

Search Agent Observability spans.

Search Agent Observability spans using structured filters in the request body.

Parameters:

Returns:

  • (Array<(LLMObsSpansResponse, Integer, Hash)>) —

    LLMObsSpansResponse data, response status code and response headers



4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4437

def search_llm_obs_spans_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.search_llm_obs_spans".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.search_llm_obs_spans")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.search_llm_obs_spans"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.search_llm_obs_spans ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.search_llm_obs_spans"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/spans/events/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsSpansResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :search_llm_obs_spans,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#search_llm_obs_spans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#simple_search_llm_obs_experimentation(body, opts = {}) ⇒ Object

Simple search experimentation entities.

See Also:



4498
4499
4500
4501
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4498

def simple_search_llm_obs_experimentation(body, opts = {})
  data, _status_code, _headers = simple_search_llm_obs_experimentation_with_http_info(body, opts)
  data
end

#simple_search_llm_obs_experimentation_with_http_info(body, opts = {}) ⇒ Array<(LLMObsExperimentationSimpleSearchResponse, Integer, Hash)>

Simple search experimentation entities.

Search across Agent Observability experimentation entities using offset-based (page-number) pagination. Use this endpoint when you need total page count or want to navigate to a specific page number.

The filter.scope field controls which entity types are returned. At least one valid scope must be provided.

Parameters:

Returns:



4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4513

def simple_search_llm_obs_experimentation_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.simple_search_llm_obs_experimentation".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.simple_search_llm_obs_experimentation")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.simple_search_llm_obs_experimentation"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.simple_search_llm_obs_experimentation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.simple_search_llm_obs_experimentation"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experimentation/simple-search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentationSimpleSearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :simple_search_llm_obs_experimentation,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#simple_search_llm_obs_experimentation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trigger_llm_obs_patterns(body, opts = {}) ⇒ Object

Trigger a patterns run.

See Also:



4574
4575
4576
4577
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4574

def trigger_llm_obs_patterns(body, opts = {})
  data, _status_code, _headers = trigger_llm_obs_patterns_with_http_info(body, opts)
  data
end

#trigger_llm_obs_patterns_with_http_info(body, opts = {}) ⇒ Array<(LLMObsPatternsTriggerResponse, Integer, Hash)>

Trigger a patterns run.

Start a patterns run for a given configuration. The run executes asynchronously.

Parameters:

Returns:



4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4586

def trigger_llm_obs_patterns_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.trigger_llm_obs_patterns".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.trigger_llm_obs_patterns")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.trigger_llm_obs_patterns"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.trigger_llm_obs_patterns ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.trigger_llm_obs_patterns"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-runs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsTriggerResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :trigger_llm_obs_patterns,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#trigger_llm_obs_patterns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unlock_llm_obs_dataset_draft_state(project_id, dataset_id, opts = {}) ⇒ Object

Unlock Agent Observability dataset draft state.

See Also:



4647
4648
4649
4650
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4647

def unlock_llm_obs_dataset_draft_state(project_id, dataset_id, opts = {})
  unlock_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts)
  nil
end

#unlock_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unlock Agent Observability dataset draft state.

Release the draft lock on a dataset held by the calling user, allowing other users to edit the dataset draft.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4660

def unlock_llm_obs_dataset_draft_state_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.unlock_llm_obs_dataset_draft_state".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.unlock_llm_obs_dataset_draft_state")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.unlock_llm_obs_dataset_draft_state"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.unlock_llm_obs_dataset_draft_state ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.unlock_llm_obs_dataset_draft_state"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.unlock_llm_obs_dataset_draft_state"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/draft_state/unlock'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :unlock_llm_obs_dataset_draft_state,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#unlock_llm_obs_dataset_draft_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_annotation_queue(queue_id, body, opts = {}) ⇒ Object

Update an Agent Observability annotation queue.

See Also:



4723
4724
4725
4726
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4723

def update_llm_obs_annotation_queue(queue_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_annotation_queue_with_http_info(queue_id, body, opts)
  data
end

#update_llm_obs_annotation_queue_label_schema(queue_id, body, opts = {}) ⇒ Object

Update annotation queue label schema.

See Also:



4803
4804
4805
4806
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4803

def update_llm_obs_annotation_queue_label_schema(queue_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_annotation_queue_label_schema_with_http_info(queue_id, body, opts)
  data
end

#update_llm_obs_annotation_queue_label_schema_with_http_info(queue_id, body, opts = {}) ⇒ Array<(LLMObsAnnotationQueueLabelSchemaResponse, Integer, Hash)>

Update annotation queue label schema.

Create or replace the label schema for a given annotation queue. The label schema defines the labels annotators can apply to interactions in the queue. Label names must be unique within the queue and match the pattern ^[a-zA-Z0-9_-]+$. Each label must have a valid type: score, categorical, boolean, or text.

Parameters:

Returns:



4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4819

def update_llm_obs_annotation_queue_label_schema_with_http_info(queue_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_annotation_queue_label_schema".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_annotation_queue_label_schema")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_annotation_queue_label_schema"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_annotation_queue_label_schema ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.update_llm_obs_annotation_queue_label_schema"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_annotation_queue_label_schema"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/label-schema'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationQueueLabelSchemaResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_annotation_queue_label_schema,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_annotation_queue_label_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_annotation_queue_with_http_info(queue_id, body, opts = {}) ⇒ Array<(LLMObsAnnotationQueueResponse, Integer, Hash)>

Update an Agent Observability annotation queue.

Partially update an annotation queue. The name, description, annotation_schema, reviewer_emails, restrict_to_reviewers, and restrict_to_assignees fields can be updated.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • body (LLMObsAnnotationQueueUpdateRequest) —

    Update annotation queue payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4738

def update_llm_obs_annotation_queue_with_http_info(queue_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_annotation_queue".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_annotation_queue")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_annotation_queue"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_annotation_queue ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.update_llm_obs_annotation_queue"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_annotation_queue"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationQueueResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_annotation_queue,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_annotation_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_custom_eval_config(eval_name, body, opts = {}) ⇒ Object

Create or update a custom evaluator configuration.

See Also:



4884
4885
4886
4887
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4884

def update_llm_obs_custom_eval_config(eval_name, body, opts = {})
  update_llm_obs_custom_eval_config_with_http_info(eval_name, body, opts)
  nil
end

#update_llm_obs_custom_eval_config_with_http_info(eval_name, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create or update a custom evaluator configuration.

Create or update a custom Agent Observability evaluator configuration by its name.

Parameters:

  • eval_name (String) —

    The name of the custom Agent Observability evaluator configuration.

  • body (LLMObsCustomEvalConfigUpdateRequest) —

    Custom evaluator configuration payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4897

def update_llm_obs_custom_eval_config_with_http_info(eval_name, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_custom_eval_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_custom_eval_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_custom_eval_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_custom_eval_config ...'
  end
  # verify the required parameter 'eval_name' is set
  if @api_client.config.client_side_validation && eval_name.nil?
    fail ArgumentError, "Missing the required parameter 'eval_name' when calling AgentObservabilityAPI.update_llm_obs_custom_eval_config"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_custom_eval_config"
  end
  # resource path
  local_var_path = '/api/unstable/llm-obs/config/evaluators/custom/{eval_name}'.sub('{eval_name}', CGI.escape(eval_name.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_custom_eval_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_custom_eval_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_dataset(project_id, dataset_id, body, opts = {}) ⇒ Object

Update an Agent Observability dataset.

See Also:



4962
4963
4964
4965
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4962

def update_llm_obs_dataset(project_id, dataset_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts)
  data
end

#update_llm_obs_dataset_records(project_id, dataset_id, body, opts = {}) ⇒ Object

Update Agent Observability dataset records.

See Also:



5045
5046
5047
5048
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5045

def update_llm_obs_dataset_records(project_id, dataset_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts)
  data
end

#update_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(LLMObsDatasetRecordsMutationResponse, Integer, Hash)>

Update Agent Observability dataset records.

Update one or more existing records in an Agent Observability dataset.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • body (LLMObsDatasetRecordsUpdateRequest) —

    Update records payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5059

def update_llm_obs_dataset_records_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_dataset_records".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_dataset_records")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_dataset_records"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_dataset_records ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.update_llm_obs_dataset_records"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.update_llm_obs_dataset_records"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_dataset_records"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetRecordsMutationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_dataset_records,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_dataset_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts = {}) ⇒ Array<(LLMObsDatasetResponse, Integer, Hash)>

Update an Agent Observability dataset.

Partially update an existing Agent Observability dataset within the specified project.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • body (LLMObsDatasetUpdateRequest) —

    Update dataset payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsDatasetResponse, Integer, Hash)>) —

    LLMObsDatasetResponse data, response status code and response headers



4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 4976

def update_llm_obs_dataset_with_http_info(project_id, dataset_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_dataset".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_dataset")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_dataset"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_dataset ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.update_llm_obs_dataset"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.update_llm_obs_dataset"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_dataset"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsDatasetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_dataset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_experiment(experiment_id, body, opts = {}) ⇒ Object

Update an Agent Observability experiment.

See Also:



5128
5129
5130
5131
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5128

def update_llm_obs_experiment(experiment_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_experiment_with_http_info(experiment_id, body, opts)
  data
end

#update_llm_obs_experiment_with_http_info(experiment_id, body, opts = {}) ⇒ Array<(LLMObsExperimentResponse, Integer, Hash)>

Update an Agent Observability experiment.

Partially update an existing Agent Observability experiment.

Parameters:

  • experiment_id (String) —

    The ID of the Agent Observability experiment.

  • body (LLMObsExperimentUpdateRequest) —

    Update experiment payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsExperimentResponse, Integer, Hash)>) —

    LLMObsExperimentResponse data, response status code and response headers



5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5141

def update_llm_obs_experiment_with_http_info(experiment_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_experiment".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_experiment")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_experiment"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_experiment ...'
  end
  # verify the required parameter 'experiment_id' is set
  if @api_client.config.client_side_validation && experiment_id.nil?
    fail ArgumentError, "Missing the required parameter 'experiment_id' when calling AgentObservabilityAPI.update_llm_obs_experiment"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_experiment"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/experiments/{experiment_id}'.sub('{experiment_id}', CGI.escape(experiment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsExperimentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_experiment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_project(project_id, body, opts = {}) ⇒ Object

Update an Agent Observability project.

See Also:



5206
5207
5208
5209
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5206

def update_llm_obs_project(project_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_project_with_http_info(project_id, body, opts)
  data
end

#update_llm_obs_project_with_http_info(project_id, body, opts = {}) ⇒ Array<(LLMObsProjectResponse, Integer, Hash)>

Update an Agent Observability project.

Partially update an existing Agent Observability project.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • body (LLMObsProjectUpdateRequest) —

    Update project payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsProjectResponse, Integer, Hash)>) —

    LLMObsProjectResponse data, response status code and response headers



5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5219

def update_llm_obs_project_with_http_info(project_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_project".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_project")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_project"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_project ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.update_llm_obs_project"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_project"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/projects/{project_id}'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsProjectResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_project,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_prompt(prompt_id, body, opts = {}) ⇒ Object

Update an Agent Observability prompt.

See Also:



5284
5285
5286
5287
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5284

def update_llm_obs_prompt(prompt_id, body, opts = {})
  data, _status_code, _headers = update_llm_obs_prompt_with_http_info(prompt_id, body, opts)
  data
end

#update_llm_obs_prompt_version(prompt_id, version, body, opts = {}) ⇒ Object

Update an Agent Observability prompt version.

See Also:



5362
5363
5364
5365
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5362

def update_llm_obs_prompt_version(prompt_id, version, body, opts = {})
  data, _status_code, _headers = update_llm_obs_prompt_version_with_http_info(prompt_id, version, body, opts)
  data
end

#update_llm_obs_prompt_version_with_http_info(prompt_id, version, body, opts = {}) ⇒ Array<(LLMObsPromptVersionResponse, Integer, Hash)>

Update an Agent Observability prompt version.

Update the description, the feature-flag environments, or both, for a specific version of an Agent Observability prompt.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • version (Integer) —

    The version number of the Agent Observability prompt.

  • body (LLMObsUpdatePromptVersionRequest) —

    Update prompt version payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsPromptVersionResponse, Integer, Hash)>) —

    LLMObsPromptVersionResponse data, response status code and response headers



5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5376

def update_llm_obs_prompt_version_with_http_info(prompt_id, version, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_prompt_version".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_prompt_version")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_prompt_version"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_prompt_version ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.update_llm_obs_prompt_version"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling AgentObservabilityAPI.update_llm_obs_prompt_version"
  end
  if @api_client.config.client_side_validation && version < 1
    fail ArgumentError, 'invalid value for "version" when calling AgentObservabilityAPI.update_llm_obs_prompt_version, must be greater than or equal to 1.'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_prompt_version"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version}'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/')).sub('{version}', CGI.escape(version.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptVersionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_prompt_version,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_prompt_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_llm_obs_prompt_with_http_info(prompt_id, body, opts = {}) ⇒ Array<(LLMObsPromptResponse, Integer, Hash)>

Update an Agent Observability prompt.

Update the title, the description, or both, for an Agent Observability prompt.

Parameters:

  • prompt_id (String) —

    The customer-provided identifier of the Agent Observability prompt.

  • body (LLMObsUpdatePromptRequest) —

    Update prompt payload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsPromptResponse, Integer, Hash)>) —

    LLMObsPromptResponse data, response status code and response headers



5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5297

def update_llm_obs_prompt_with_http_info(prompt_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_llm_obs_prompt".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_llm_obs_prompt")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_llm_obs_prompt"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.update_llm_obs_prompt ...'
  end
  # verify the required parameter 'prompt_id' is set
  if @api_client.config.client_side_validation && prompt_id.nil?
    fail ArgumentError, "Missing the required parameter 'prompt_id' when calling AgentObservabilityAPI.update_llm_obs_prompt"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.update_llm_obs_prompt"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/prompts/{prompt_id}'.sub('{prompt_id}', CGI.escape(prompt_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPromptResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_llm_obs_prompt,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#update_llm_obs_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_llm_obs_dataset_records_file(project_id, dataset_id, opts = {}) ⇒ Object

Upload records to an Agent Observability dataset.

See Also:



5448
5449
5450
5451
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5448

def upload_llm_obs_dataset_records_file(project_id, dataset_id, opts = {})
  upload_llm_obs_dataset_records_file_with_http_info(project_id, dataset_id, opts)
  nil
end

#upload_llm_obs_dataset_records_file_with_http_info(project_id, dataset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upload records to an Agent Observability dataset.

Upload records to a dataset from a file. The request is a multipart/form-data upload containing a single file part. Currently only CSV is supported. The CSV must include an input column. Optional columns are id, expected_output, metadata, and tags.

The response is a Server-Sent Events stream (text/event-stream) emitting progress updates while records are processed. The stream emits the following named events:

  • progress: incremental record counts written so far.
  • completed: terminal event with a JSON body containing records_created.
  • error: terminal event with a JSON body containing an error message.

Parameters:

  • project_id (String) —

    The ID of the Agent Observability project.

  • dataset_id (String) —

    The ID of the Agent Observability dataset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :deduplicate (Boolean) —

    Whether to skip records whose input already exists in the dataset. Defaults to false.

  • :overwrite (Boolean) —

    Whether to overwrite existing records that share the same user-provided id. Defaults to true.

  • :tags (Array<String>) —

    Tags to apply to every uploaded record, in addition to any tags defined on individual rows. Can be repeated, e.g. tags=env:prod&tags=team:ai.

  • :include_user_data (Boolean) —

    Whether to enrich the response with user metadata.

  • :file (File) —

    The records file to upload. Currently only CSV is supported. The file must include an input column. Optional columns include id, expected_output, metadata, and tags.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5472

def upload_llm_obs_dataset_records_file_with_http_info(project_id, dataset_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.upload_llm_obs_dataset_records_file".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.upload_llm_obs_dataset_records_file")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.upload_llm_obs_dataset_records_file"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.upload_llm_obs_dataset_records_file ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling AgentObservabilityAPI.upload_llm_obs_dataset_records_file"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling AgentObservabilityAPI.upload_llm_obs_dataset_records_file"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v2/{project_id}/datasets/{dataset_id}/records/upload'.sub('{project_id}', CGI.escape(project_id.to_s).gsub('%2F', '/')).sub('{dataset_id}', CGI.escape(dataset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'deduplicate'] = opts[:'deduplicate'] if !opts[:'deduplicate'].nil?
  query_params[:'overwrite'] = opts[:'overwrite'] if !opts[:'overwrite'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
  query_params[:'include[user_data]'] = opts[:'include_user_data'] if !opts[:'include_user_data'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :upload_llm_obs_dataset_records_file,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#upload_llm_obs_dataset_records_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_llm_obs_annotations(queue_id, body, opts = {}) ⇒ Object

Create or update annotations.

See Also:



5543
5544
5545
5546
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5543

def upsert_llm_obs_annotations(queue_id, body, opts = {})
  data, _status_code, _headers = upsert_llm_obs_annotations_with_http_info(queue_id, body, opts)
  data
end

#upsert_llm_obs_annotations_with_http_info(queue_id, body, opts = {}) ⇒ Array<(LLMObsAnnotationsResponse, Integer, Hash)>

Create or update annotations.

Create or update annotations on interactions in a queue. Each annotation is matched by interaction_id and the requesting user's identity. Results and errors in the response are linked to request items by interaction_id. Errors for individual items are returned in the errors field without blocking the rest of the batch. Requests where every item is denied by queue access rules return 403.

Parameters:

  • queue_id (String) —

    The ID of the Agent Observability annotation queue.

  • body (LLMObsAnnotationsRequest) —

    Payload for creating or updating annotations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LLMObsAnnotationsResponse, Integer, Hash)>) —

    LLMObsAnnotationsResponse data, response status code and response headers



5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5560

def upsert_llm_obs_annotations_with_http_info(queue_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.upsert_llm_obs_annotations".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.upsert_llm_obs_annotations")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.upsert_llm_obs_annotations"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.upsert_llm_obs_annotations ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling AgentObservabilityAPI.upsert_llm_obs_annotations"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.upsert_llm_obs_annotations"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotations'.sub('{queue_id}', CGI.escape(queue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsAnnotationsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :upsert_llm_obs_annotations,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#upsert_llm_obs_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_llm_obs_patterns_config(body, opts = {}) ⇒ Object

Create or update a patterns configuration.

See Also:



5625
5626
5627
5628
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5625

def upsert_llm_obs_patterns_config(body, opts = {})
  data, _status_code, _headers = upsert_llm_obs_patterns_config_with_http_info(body, opts)
  data
end

#upsert_llm_obs_patterns_config_with_http_info(body, opts = {}) ⇒ Array<(LLMObsPatternsConfigResponse, Integer, Hash)>

Create or update a patterns configuration.

Create a new patterns configuration, or update an existing one when a configuration ID is provided.

Parameters:

Returns:



5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
 
# File 'lib/datadog_api_client/v2/api/agent_observability_api.rb', line 5637

def upsert_llm_obs_patterns_config_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.upsert_llm_obs_patterns_config".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.upsert_llm_obs_patterns_config")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.upsert_llm_obs_patterns_config"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentObservabilityAPI.upsert_llm_obs_patterns_config ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AgentObservabilityAPI.upsert_llm_obs_patterns_config"
  end
  # resource path
  local_var_path = '/api/v2/llm-obs/v1/topic-discovery-configs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'LLMObsPatternsConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :upsert_llm_obs_patterns_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentObservabilityAPI#upsert_llm_obs_patterns_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end