Skip to content

Commit

Permalink
Edit defaultModel generative AI connector description (#166405)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Sep 25, 2023
1 parent f73f70c commit 1c427a4
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 19 deletions.
9 changes: 5 additions & 4 deletions docs/management/connectors/action-types/gen-ai.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ image::management/connectors/images/gen-ai-connector.png[Generative AI connector

Generative AI connectors have the following configuration properties:

Name:: The name of the connector.
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.
Name:: The name of the connector.
OpenAI provider:: The OpenAI API provider, either OpenAI or Azure OpenAI.
URL:: The OpenAI request URL.
Default model:: (optional) The default model to use for requests. This option is available only when the provider is `OpenAI`.
API key:: The OpenAI or Azure OpenAI API key for authentication.

[float]
[[gen-ai-action-configuration]]
Expand Down
Binary file modified docs/management/connectors/images/gen-ai-connector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,8 @@ export const openAiConfig: ConfigFieldSchema[] = [
label: i18n.DEFAULT_MODEL_LABEL,
helpText: (
<FormattedMessage
defaultMessage='The model can be set on a per request basis by including a "model" parameter in the request body. If no model is provided, the fallback will be the default model. For more information, refer to the {genAiAPIModelDocs}.'
defaultMessage="If a request does not include a model, it uses the default."
id="xpack.stackConnectors.components.genAi.openAiDocumentationModel"
values={{
genAiAPIModelDocs: (
<EuiLink
data-test-subj="open-ai-api-doc"
href="https://platform.openai.com/docs/api-reference/models"
target="_blank"
>
{`${i18n.OPEN_AI} ${i18n.DOCUMENTATION}`}
</EuiLink>
),
}}
/>
),
defaultValue: DEFAULT_OPENAI_MODEL,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const API_URL_LABEL = i18n.translate(
);

export const API_KEY_LABEL = i18n.translate('xpack.stackConnectors.components.genAi.apiKeySecret', {
defaultMessage: 'API Key',
defaultMessage: 'API key',
});

export const DEFAULT_MODEL_LABEL = i18n.translate(
Expand All @@ -28,8 +28,7 @@ export const DEFAULT_MODEL_LABEL = i18n.translate(
export const DEFAULT_MODEL_TOOLTIP_CONTENT = i18n.translate(
'xpack.stackConnectors.components.genAi.defaultModelTooltipContent',
{
defaultMessage:
'The model can be set on a per request basis by including a "model" parameter in the request body. If no model is provided, the fallback will be the default model.',
defaultMessage: 'If a request does not include a model, it uses the default.',
}
);

Expand Down

0 comments on commit 1c427a4

Please sign in to comment.