Skip to content

Commit

Permalink
[DOCS] Remove inference connector docs (#198633)
Browse files Browse the repository at this point in the history
(cherry picked from commit 517063d)
  • Loading branch information
lcawl committed Nov 12, 2024
1 parent 367d479 commit 422cff6
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 21 deletions.
10 changes: 6 additions & 4 deletions docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Actions are instantiations of a connector that are linked to rules and run as ba
[cols="2"]
|===

// ifeval::["featureAIConnector"=="true"]
// a| <<inference-action-type,{infer}>>

// | Send a request to {infer}.
// endif::[]

a| <<bedrock-action-type,{bedrock}>>

| Send a request to {bedrock}.
Expand All @@ -28,10 +34,6 @@ a| <<gemini-action-type,{gemini}>>

| Send a request to {gemini}.

a| <<inference-action-type,{infer}>>

| Send a request to {infer}.

a| <<email-action-type,Email>>

| Send email from your server.
Expand Down
6 changes: 4 additions & 2 deletions docs/management/connectors/action-types/inference.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
[[inference-action-type]]
== {infer-cap} connector and action
== AI connector and action
++++
<titleabbrev>{infer-cap}</titleabbrev>
<titleabbrev>AI</titleabbrev>
++++
:frontmatter-description: Add a connector that can send requests to {inference}.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]

coming::[]

The {infer} connector uses the {es} client to send requests to an {infer} service.
The connector uses the <<execute-connector-api,run connector API>> to send the request.
Expand All @@ -16,6 +17,7 @@ The connector uses the <<execute-connector-api,run connector API>> to send the r
[[define-inference-ui]]
=== Create connectors in {kib}

// TBD After you set the `xpack.stack_connectors.enableExperimental` to include `inferenceConnectorOn`,
You can create connectors in *{stack-manage-app} > {connectors-ui}*. For example:

[role="screenshot"]
Expand Down
4 changes: 3 additions & 1 deletion docs/management/connectors/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ include::action-types/crowdstrike.asciidoc[leveloffset=+1]
include::action-types/d3security.asciidoc[leveloffset=+1]
include::action-types/email.asciidoc[leveloffset=+1]
include::action-types/gemini.asciidoc[leveloffset=+1]
include::action-types/inference.asciidoc[leveloffset=+1]
// ifeval::["featureAIConnector"=="true"]
// include::action-types/inference.asciidoc[leveloffset=+1]
// endif::[]
include::action-types/resilient.asciidoc[leveloffset=+1]
include::action-types/index.asciidoc[leveloffset=+1]
include::action-types/jira.asciidoc[leveloffset=+1]
Expand Down
5 changes: 3 additions & 2 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -283,15 +283,16 @@ A configuration URL that varies by connector:
--
* For an <<bedrock-action-type,{bedrock} connector>>, specifies the {bedrock} request URL.
* For an <<gemini-action-type,{gemini} connector>>, specifies the {gemini} request URL.
* For an <<inference-action-type,{inference} connector>>, specifies the Elastic {inference} request.
* For a <<openai-action-type,OpenAI connector>>, specifies the OpenAI request URL.
* For a <<resilient-action-type,{ibm-r} connector>>, specifies the {ibm-r} instance URL.
* For a <<jira-action-type,Jira connector>>, specifies the Jira instance URL.
* For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`.
* For a <<pagerduty-action-type,PagerDuty connector>>, specifies the PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`.
* For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>> specifies the ServiceNow instance URL.
* For a <<swimlane-action-type,{swimlane} connector>>, specifies the {swimlane} instance URL.

// ifeval::["featureAIConnector"=="true"]
// * For an <<inference-action-type,AI connector>>, specifies the Elastic {inference} request.
// endif::[]
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
--

Expand Down
11 changes: 0 additions & 11 deletions oas_docs/examples/get_connector_types_generativeai_response.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,3 @@ value:
supported_feature_ids:
- generativeAIForSecurity
is_system_action_type: false
- id: .inference
name: Inference API
enabled: true
enabled_in_config: true
enabled_in_license: true
minimum_license_required: enterprise
supported_feature_ids:
- generativeAIForSecurity
- generativeAIForObservability
- generativeAIForSearchPlayground
is_system_action_type: false
8 changes: 8 additions & 0 deletions oas_docs/overlays/connectors.overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ actions:
default: {}
description: The connector configuration details.
oneOf:
# AI (.inference) TBD
# - $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/inference_config.yaml'
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_config.yaml'
# Crowdstrike (.crowdstrike)
Expand Down Expand Up @@ -194,6 +196,8 @@ actions:
additionalProperties: {}
default: {}
oneOf:
# AI (.inference)
# - $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/inference_secrets.yaml'
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_secrets.yaml'
# Crowdstrike (.crowdstrike)
Expand Down Expand Up @@ -253,6 +257,8 @@ actions:
default: {}
description: The connector configuration details.
oneOf:
# AI (.inference)
# - $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/inference_config.yaml'
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_config.yaml'
# Crowdstrike (.crowdstrike)
Expand Down Expand Up @@ -307,6 +313,8 @@ actions:
additionalProperties: {}
default: {}
oneOf:
# AI (.inference)
# - $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/inference_secrets.yaml'
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_secrets.yaml'
# Crowdstrike (.crowdstrike)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: The type of connector. For example, `.email`, `.index`, `.jira`, `.
enum:
- .bedrock
- .gemini
- .inference
- .cases-webhook
- .d3security
- .email
Expand Down

0 comments on commit 422cff6

Please sign in to comment.