Class: DatadogAPIClient::V2::LLMObservabilityAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LLMObservabilityAPI.



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

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

Create an LLM Observability annotation queue.



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

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.



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

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 (traces or sessions) to an annotation queue. At least one interaction must be provided.

Parameters:

  • queue_id (String)

    The ID of the LLM Observability annotation queue.

  • body (LLMObsAnnotationQueueInteractionsRequest)

    Add interactions 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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 119

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM 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. Fields such as `created_by`, `owned_by`, `created_at`, `modified_by`, and `modified_at` are inferred by the backend.

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/llm_observability_api.rb', line 44

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability dataset.



184
185
186
187
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 184

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 LLM Observability dataset.



262
263
264
265
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 262

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 LLM Observability dataset.

Append one or more records to an LLM Observability dataset.

Parameters:

  • project_id (String)

    The ID of the LLM Observability project.

  • dataset_id (String)

    The ID of the LLM Observability dataset.

  • body (LLMObsDatasetRecordsRequest)

    Append records payload.

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

    the optional parameters

Returns:



276
277
278
279
280
281
282
283
284
285
286
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 276

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability dataset.

Create a new LLM Observability dataset within the specified project.

Parameters:

  • project_id (String)

    The ID of the LLM 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



197
198
199
200
201
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 197

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability experiment.



345
346
347
348
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 345

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 LLM Observability experiment.



418
419
420
421
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 418

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 LLM Observability experiment.

Push spans and metrics for an LLM Observability experiment.

Parameters:

  • experiment_id (String)

    The ID of the LLM 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



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 431

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability experiment.

Create a new LLM 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



357
358
359
360
361
362
363
364
365
366
367
368
369
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 357

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#create_llm_obs_experiment\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 LLM Observability project.



496
497
498
499
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 496

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 LLM Observability project.

Create a new LLM 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



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 508

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#create_llm_obs_project\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 LLM Observability annotation queue.



569
570
571
572
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 569

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.



640
641
642
643
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 640

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



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 653

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability annotation queue.

Delete an annotation queue by its ID.

Parameters:

  • queue_id (String)

    The ID of the LLM Observability annotation queue.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 581

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#delete_llm_obs_annotation_queue\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.



718
719
720
721
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 718

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 LLM Observability evaluator configuration by its name.

Parameters:

  • eval_name (String)

    The name of the custom LLM Observability evaluator configuration.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 730

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability dataset records.



789
790
791
792
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 789

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 LLM Observability dataset records.

Delete one or more records from an LLM Observability dataset.

Parameters:

  • project_id (String)

    The ID of the LLM Observability project.

  • dataset_id (String)

    The ID of the LLM 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



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
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 803

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability datasets.



872
873
874
875
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 872

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 LLM Observability datasets.

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

Parameters:

  • project_id (String)

    The ID of the LLM 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



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 885

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability experiments.



950
951
952
953
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 950

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 LLM Observability experiments.

Delete one or more LLM Observability experiments.

Parameters:

Returns:

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

    nil, response status code and response headers



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 962

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#delete_llm_obs_experiments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete LLM Observability projects.



1023
1024
1025
1026
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1023

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 LLM Observability projects.

Delete one or more LLM Observability projects.

Parameters:

Returns:

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

    nil, response status code and response headers



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1035

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#delete_llm_obs_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get annotated queue interactions.



1096
1097
1098
1099
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1096

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_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 LLM Observability annotation queue.

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

    the optional parameters

Returns:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1108

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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.



1167
1168
1169
1170
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1167

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 LLM Observability annotation queue.

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

    the optional parameters

Returns:



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
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1179

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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.



1238
1239
1240
1241
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1238

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 LLM Observability evaluator configuration by its name.

Parameters:

  • eval_name (String)

    The name of the custom LLM Observability evaluator configuration.

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

    the optional parameters

Returns:



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
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1250

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#get_llm_obs_custom_eval_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_annotation_queues(opts = {}) ⇒ Object

List LLM Observability annotation queues.



1309
1310
1311
1312
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1309

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 LLM 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:



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
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1323

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: LLMObservabilityAPI.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: LLMObservabilityAPI#list_llm_obs_annotation_queues\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 LLM Observability dataset records.



1381
1382
1383
1384
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1381

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 LLM Observability dataset records.

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

Parameters:

  • project_id (String)

    The ID of the LLM Observability project.

  • dataset_id (String)

    The ID of the LLM 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:



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
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1397

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#list_llm_obs_dataset_records\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 LLM Observability datasets.



1463
1464
1465
1466
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1463

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 LLM Observability datasets.

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

Parameters:

  • project_id (String)

    The ID of the LLM 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



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
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1479

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#list_llm_obs_datasets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_experiments(opts = {}) ⇒ Object

List LLM Observability experiments.



1542
1543
1544
1545
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1542

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 LLM Observability experiments.

List all LLM 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` 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.

  • :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<(LLMObsExperimentsResponse, Integer, Hash)>)

    LLMObsExperimentsResponse data, response status code and response headers



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
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1558

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: LLMObservabilityAPI.list_llm_obs_experiments ...'
  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[:'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: LLMObservabilityAPI#list_llm_obs_experiments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_llm_obs_projects(opts = {}) ⇒ Object

List LLM Observability projects.



1618
1619
1620
1621
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1618

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 LLM Observability projects.

List all LLM 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



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
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1633

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: LLMObservabilityAPI.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: LLMObservabilityAPI#list_llm_obs_projects\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 LLM Observability annotation queue.



1692
1693
1694
1695
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1692

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.



1770
1771
1772
1773
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1770

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:



1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
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
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1786

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability annotation queue.

Partially update an annotation queue. The ‘name`, `description`, and `annotation_schema` fields can be updated.

Parameters:

  • queue_id (String)

    The ID of the LLM Observability annotation queue.

  • body (LLMObsAnnotationQueueUpdateRequest)

    Update annotation queue payload.

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

    the optional parameters

Returns:



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
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1705

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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.



1851
1852
1853
1854
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1851

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 LLM Observability evaluator configuration by its name.

Parameters:

  • eval_name (String)

    The name of the custom LLM 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



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
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1864

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability dataset.



1929
1930
1931
1932
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1929

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 LLM Observability dataset records.



2012
2013
2014
2015
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 2012

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 LLM Observability dataset records.

Update one or more existing records in an LLM Observability dataset.

Parameters:

  • project_id (String)

    The ID of the LLM Observability project.

  • dataset_id (String)

    The ID of the LLM Observability dataset.

  • body (LLMObsDatasetRecordsUpdateRequest)

    Update records payload.

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

    the optional parameters

Returns:



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
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 2026

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability dataset.

Partially update an existing LLM Observability dataset within the specified project.

Parameters:

  • project_id (String)

    The ID of the LLM Observability project.

  • dataset_id (String)

    The ID of the LLM 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



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
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 1943

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability experiment.



2095
2096
2097
2098
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 2095

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 LLM Observability experiment.

Partially update an existing LLM Observability experiment.

Parameters:

  • experiment_id (String)

    The ID of the LLM 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



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
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 2108

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#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 LLM Observability project.



2173
2174
2175
2176
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 2173

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 LLM Observability project.

Partially update an existing LLM Observability project.

Parameters:

  • project_id (String)

    The ID of the LLM 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



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
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
# File 'lib/datadog_api_client/v2/api/llm_observability_api.rb', line 2186

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: LLMObservabilityAPI.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 LLMObservabilityAPI.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 LLMObservabilityAPI.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: LLMObservabilityAPI#update_llm_obs_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end