Files
elasticsearch-js/docs/reference-inference-inference.asciidoc
2024-12-05 14:46:46 -06:00

66 lines
4.0 KiB
Plaintext

[[reference-inference-inference]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.inference.inference
Perform inference on the service
{ref}/post-inference-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(InferenceInferenceRequest, options?): Promise<InferenceInferenceResponse>
----
[discrete]
===== `InferenceInferenceRequest`
[source,ts]
----
interface InferenceInferenceRequest extends <<shared-type-request-base, RequestBase>> {
task_type?: InferenceTaskType
inference_id: <<shared-type-id, Id>>
timeout?: <<shared-type-duration, Duration>>
query?: string
input: string | string[]
task_settings?: InferenceTaskSettings
}
----
[discrete]
===== `InferenceInferenceResponse`
[source,ts]
----
type InferenceInferenceResponse = InferenceInferenceResult
----