diff --git a/docs/management/connectors/action-types/gen-ai.asciidoc b/docs/management/connectors/action-types/gen-ai.asciidoc index df67b6c13f412..5e1b3553309ac 100644 --- a/docs/management/connectors/action-types/gen-ai.asciidoc +++ b/docs/management/connectors/action-types/gen-ai.asciidoc @@ -3,6 +3,11 @@ ++++ Generative AI ++++ +:frontmatter-description: Add a connector that can send requests to an OpenAI provider. +:frontmatter-tags-products: [kibana] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [configure] + The Generative AI connector uses https://github.com/axios/axios[axios] to send a POST request to an OpenAI provider, either OpenAI or Azure OpenAI. The connector uses the <> to send the request. @@ -27,36 +32,6 @@ API Provider:: The OpenAI API provider, either OpenAI or Azure OpenAI. API URL:: The OpenAI request URL. API Key:: The OpenAI or Azure OpenAI API key for authentication. -[float] -[[preconfigured-gen-ai-configuration]] -=== Create preconfigured connectors - -If you are running {kib} on-prem, you can define connectors by -adding `xpack.actions.preconfigured` settings to your `kibana.yml` file. -For example: - -[source,text] --- -xpack.actions.preconfigured: - my-gen-ai: - name: preconfigured-gen-ai-connector-type - actionTypeId: .gen-ai - config: - apiUrl: https://api.openai.com/v1/chat/completions - apiProvider: 'Azure OpenAI' - secrets: - apiKey: superlongapikey --- - -Config defines information for the connector type. - -`apiProvider`:: A string that corresponds to *OpenAI API Provider*. -`apiUrl`:: A URL string that corresponds to the *OpenAI API URL*. - -Secrets defines sensitive information for the connector type. - -`apiKey`:: A string that corresponds to *OpenAI API Key*. - [float] [[gen-ai-action-configuration]] === Test connectors diff --git a/docs/management/connectors/pre-configured-connectors.asciidoc b/docs/management/connectors/pre-configured-connectors.asciidoc index b0f472907e56c..72f5f78f6e728 100644 --- a/docs/management/connectors/pre-configured-connectors.asciidoc +++ b/docs/management/connectors/pre-configured-connectors.asciidoc @@ -108,8 +108,9 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre === Examples * <> -* <> * <> +* <> +* <> * <> * <> * <> @@ -276,6 +277,30 @@ secrets: password: -------------------------------------------------- +[float] +[[preconfigured-gen-ai-configuration]] +==== Generative AI connectors + +The following example creates a <>: + +[source,text] +-- +xpack.actions.preconfigured: + my-gen-ai: + name: preconfigured-gen-ai-connector-type + actionTypeId: .gen-ai + config: + apiUrl: https://api.openai.com/v1/chat/completions <1> + apiProvider: 'OpenAI' <2> + defaultModel: gpt-4 <3> + secrets: + apiKey: superlongapikey <4> +-- +<1> The OpenAI request URL +<2> The OpenAI API provider, either `OpenAI` or `Azure OpenAI`. +<3> The default model to use for requests. This setting is optional and applicable only when `apiProvider` is `OpenAI`. +<4> The OpenAI or Azure OpenAI API key for authentication. + [float] [[preconfigured-resilient-configuration]] ==== {ibm-r} connectors diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc index 5e97018327289..c9880bdade4dc 100644 --- a/docs/settings/alert-action-settings.asciidoc +++ b/docs/settings/alert-action-settings.asciidoc @@ -260,10 +260,14 @@ For example: `.email`, `.index`, `.opsgenie`, `.server-log`, `.resilient`, `.sla `xpack.actions.preconfigured..config`:: The configuration details, which are specific to the type of preconfigured connector. +`xpack.actions.preconfigured..config.apiProvider`:: +For a <>, specifies the OpenAI API provider, either `OpenAI` or `Azure OpenAI`. + `xpack.actions.preconfigured..config.apiUrl`:: A configuration URL that varies by connector: + -- +* For a <>, specifies the OpenAI request URL. * For a <>, specifies the {ibm-r} instance URL. * For a <>, specifies the Jira instance URL. * For an <>, specifies the {opsgenie} URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`. @@ -316,6 +320,9 @@ NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the h `xpack.actions.preconfigured..config.createIncidentResponseKey`:: For a <>, specifies a string from the response body of the create case method that corresponds to the external service identifier. +`xpack.actions.preconfigured..config.defaultModel`:: +For a <>, specifies the default model to use for requests. It is optional and applicable only when `xpack.actions.preconfigured..config.apiProvider` is `OpenAI`. + `xpack.actions.preconfigured..config.executionTimeField`:: For an <>, a field that indicates when the document was indexed. @@ -437,6 +444,7 @@ TIP: Sensitive properties, such as passwords, should be stored in the <>, specifies the OpenAI or Azure OpenAI API key for authentication. * For an <>, specifies the {opsgenie} API authentication key for HTTP basic authentication. --