From 7d4119bc7375cd28103195544517ecc0fc42f872 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 30 Oct 2024 14:38:07 +0100 Subject: [PATCH 1/3] [DOCS] Fine-tunes inference connector and action docs. --- docs/management/action-types.asciidoc | 2 +- .../action-types/inference.asciidoc | 19 +++++++++++++++---- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/management/action-types.asciidoc b/docs/management/action-types.asciidoc index 361892e430afd..af432ca50150b 100644 --- a/docs/management/action-types.asciidoc +++ b/docs/management/action-types.asciidoc @@ -30,7 +30,7 @@ a| <> a| <> -| Send a request to {inference}. +| Send a request to {infer}. a| <> diff --git a/docs/management/connectors/action-types/inference.asciidoc b/docs/management/connectors/action-types/inference.asciidoc index 8c7f2840f9c5c..3f4f5ba4e63cc 100644 --- a/docs/management/connectors/action-types/inference.asciidoc +++ b/docs/management/connectors/action-types/inference.asciidoc @@ -1,7 +1,7 @@ [[inference-action-type]] == {infer-cap} connector and action ++++ -{inference} +{infer-cap} ++++ :frontmatter-description: Add a connector that can send requests to {inference}. :frontmatter-tags-products: [kibana] @@ -9,7 +9,8 @@ :frontmatter-tags-user-goals: [configure] -The {infer} connector uses the {es} client to send requests to an {infer} service. The connector uses the <> to send the request. +The {infer} connector uses the {es} client to send requests to an {infer} service. +The connector uses the <> to send the request. [float] [[define-inference-ui]] @@ -19,7 +20,7 @@ You can create connectors in *{stack-manage-app} > {connectors-ui}*. For example [role="screenshot"] image::management/connectors/images/inference-connector.png[{inference} connector] -// NOTE: This is an autogenerated screenshot. Do not edit it directly. + [float] [[inference-connector-configuration]] @@ -44,7 +45,8 @@ while creating or editing the connector in {kib}. For example: [role="screenshot"] image::management/connectors/images/inference-completion-params.png[{infer} params test] -// NOTE: This is an autogenerated screenshot. Do not edit it directly. + + [float] [[inference-connector-actions]] === {infer-cap} connector actions @@ -59,12 +61,14 @@ The following example performs a completion task on the example question. Input:: The text on which you want to perform the {infer} task. For example: + +-- [source,text] -- { input: 'What is Elastic?' } -- +-- [float] [[inference-connector-perform-text-embedding]] @@ -74,6 +78,7 @@ The following example performs a text embedding task. Input:: The text on which you want to perform the {infer} task. For example: + +-- [source,text] -- { @@ -83,6 +88,7 @@ The text on which you want to perform the {infer} task. For example: } } -- +-- Input type:: An optional string that overwrites the connector's default model. @@ -94,6 +100,7 @@ The following example performs a reranking task on the example input. Input:: The text on which you want to perform the {infer} task. Should be a string array. For example: + +-- [source,text] -- { @@ -101,6 +108,8 @@ The text on which you want to perform the {infer} task. Should be a string array query: 'star wars main character' } -- +-- + Query:: The search query text. @@ -112,12 +121,14 @@ The following example performs a sparse embedding task on the example sentence. Input:: The text on which you want to perform the {infer} task. For example: + +-- [source,text] -- { input: 'The sky above the port was the color of television tuned to a dead channel.' } -- +-- [float] [[inference-connector-networking-configuration]] From 0491babcd67c3755c2f5f909e0adc7eb2dbf758a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 30 Oct 2024 14:42:14 +0100 Subject: [PATCH 2/3] [DOCS] One more typo. --- docs/management/action-types.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/management/action-types.asciidoc b/docs/management/action-types.asciidoc index af432ca50150b..1357af980d278 100644 --- a/docs/management/action-types.asciidoc +++ b/docs/management/action-types.asciidoc @@ -28,7 +28,7 @@ a| <> | Send a request to {gemini}. -a| <> +a| <> | Send a request to {infer}. From 3e38958019d3c70ed73877c1deba0485087aa66b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 30 Oct 2024 14:59:36 +0100 Subject: [PATCH 3/3] [DOCS] More edits. --- .../action-types/inference.asciidoc | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/management/connectors/action-types/inference.asciidoc b/docs/management/connectors/action-types/inference.asciidoc index 3f4f5ba4e63cc..ea8a0be675e18 100644 --- a/docs/management/connectors/action-types/inference.asciidoc +++ b/docs/management/connectors/action-types/inference.asciidoc @@ -58,16 +58,17 @@ The {infer} actions have the following configuration properties. Properties depe ==== Completion The following example performs a completion task on the example question. + Input:: The text on which you want to perform the {infer} task. For example: + -- [source,text] --- +------------------------------------------------------------ { input: 'What is Elastic?' } --- +------------------------------------------------------------ -- [float] @@ -75,20 +76,22 @@ The text on which you want to perform the {infer} task. For example: ==== Text embedding The following example performs a text embedding task. + Input:: The text on which you want to perform the {infer} task. For example: + -- [source,text] --- +------------------------------------------------------------ { input: 'The sky above the port was the color of television tuned to a dead channel.', task_settings: { input_type: 'ingest' } } +------------------------------------------------------------ -- --- + Input type:: An optional string that overwrites the connector's default model. @@ -97,17 +100,18 @@ An optional string that overwrites the connector's default model. ==== Reranking The following example performs a reranking task on the example input. + Input:: The text on which you want to perform the {infer} task. Should be a string array. For example: + -- [source,text] --- +------------------------------------------------------------ { input: ['luke', 'like', 'leia', 'chewy', 'r2d2', 'star', 'wars'], query: 'star wars main character' } --- +------------------------------------------------------------ -- Query:: @@ -118,16 +122,17 @@ The search query text. ==== Sparse embedding The following example performs a sparse embedding task on the example sentence. + Input:: The text on which you want to perform the {infer} task. For example: + -- [source,text] --- +------------------------------------------------------------ { input: 'The sky above the port was the color of television tuned to a dead channel.' } --- +------------------------------------------------------------ -- [float]