Browse Source

[DOCS] Expands DELETE inference API docs (#109282)

* [DOCS] Expands DELETE inference API docs.

* [DOCS] Adds discrete flag.
István Zoltán Szabó 1 year ago
parent
commit
d1da412a3e
1 changed files with 15 additions and 0 deletions
  1. 15 0
      docs/reference/inference/delete-inference.asciidoc

+ 15 - 0
docs/reference/inference/delete-inference.asciidoc

@@ -43,6 +43,21 @@ The unique identifier of the {infer} endpoint to delete.
 The type of {infer} task that the model performs.
 
 
+[discrete]
+[[delete-inference-query-parms]]
+== {api-query-parms-title}
+
+`dry_run`::
+(Optional, Boolean)
+When `true`, checks the {infer} processors that reference the endpoint and
+returns them in a list, but does not deletes the endpoint. Defaults to `false`.
+
+`force`::
+(Optional, Boolean)
+Deletes the endpoint regardless if it's used in an {infer} pipeline or a in a
+`semantic_text` field.
+
+
 [discrete]
 [[delete-inference-api-example]]
 ==== {api-examples-title}