Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming the esre application into ai_search #166632

Merged
merged 17 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/kbn-doc-links/src/get_doc_links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
const ELASTIC_WEBSITE_URL = meta.elasticWebsiteUrl;
const DOCS_WEBSITE_URL = meta.docsWebsiteUrl;
const ELASTIC_GITHUB = meta.elasticGithubUrl;
const SEARCH_LABS_URL = meta.searchLabsUrl;

const ELASTICSEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`;
const KIBANA_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/`;
Expand All @@ -36,6 +37,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
const MACHINE_LEARNING_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/`;
const SERVERLESS_DOCS = `${DOCS_WEBSITE_URL}serverless/`;
const SERVERLESS_ELASTICSEARCH_DOCS = `${SERVERLESS_DOCS}elasticsearch/`;
const SEARCH_LABS_REPO = `${ELASTIC_GITHUB}elasticsearch-labs/`;

return deepFreeze({
settings: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/settings.html`,
Expand Down Expand Up @@ -128,6 +130,8 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
webCrawlerReference: `${APP_SEARCH_DOCS}web-crawler-reference.html`,
},
enterpriseSearch: {
aiSearchDoc: `${ESRE_DOCS}`,
aiSearchHelp: `${ESRE_DOCS}help.html`,
apiKeys: `${KIBANA_DOCS}api-keys.html`,
behavioralAnalytics: `${ENTERPRISE_SEARCH_DOCS}analytics-overview.html`,
behavioralAnalyticsCORS: `${ENTERPRISE_SEARCH_DOCS}analytics-cors-proxy.html`,
Expand Down Expand Up @@ -168,10 +172,6 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
documentLevelSecurity: `${ELASTICSEARCH_DOCS}document-level-security.html`,
elser: `${ENTERPRISE_SEARCH_DOCS}elser-text-expansion.html`,
engines: `${ENTERPRISE_SEARCH_DOCS}engines.html`,
esre: `${ESRE_DOCS}index.html`,
esreFaq: `${ESRE_DOCS}faq.html`,
esreHelp: `${ESRE_DOCS}help.html`,
esreLearn: `${ESRE_DOCS}learn.html`,
indexApi: `${ELASTICSEARCH_DOCS}docs-index_.html`,
ingestionApis: `${ENTERPRISE_SEARCH_DOCS}ingestion-apis.html`,
ingestPipelines: `${ENTERPRISE_SEARCH_DOCS}ingest-pipelines.html`,
Expand All @@ -188,6 +188,8 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
searchApplicationsSearchApi: `${ENTERPRISE_SEARCH_DOCS}search-applications-safe-search.html`,
searchApplications: `${ENTERPRISE_SEARCH_DOCS}search-applications.html`,
searchApplicationsSearch: `${ENTERPRISE_SEARCH_DOCS}search-applications-search.html`,
searchLabs: `${SEARCH_LABS_URL}`,
searchLabsRepo: `${SEARCH_LABS_REPO}`,
searchTemplates: `${ELASTICSEARCH_DOCS}search-template.html`,
start: `${ENTERPRISE_SEARCH_DOCS}start.html`,
supportedNlpModels: `${MACHINE_LEARNING_DOCS}ml-nlp-model-ref.html`,
Expand Down
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/get_doc_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ export const getDocLinksMeta = ({ kibanaBranch }: GetDocLinksMetaOptions): DocLi
elasticWebsiteUrl: 'https://www.elastic.co/',
elasticGithubUrl: 'https://github.com/elastic/',
docsWebsiteUrl: 'https://docs.elastic.co/',
searchLabsUrl: 'https://search-labs.elastic.co/',
};
};
9 changes: 5 additions & 4 deletions packages/kbn-doc-links/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export interface DocLinksMeta {
elasticWebsiteUrl: string;
elasticGithubUrl: string;
docsWebsiteUrl: string;
searchLabsUrl: string;
}

/**
Expand Down Expand Up @@ -110,6 +111,8 @@ export interface DocLinks {
readonly webCrawlerReference: string;
};
readonly enterpriseSearch: {
readonly aiSearchDoc: string;
readonly aiSearchHelp: string;
readonly apiKeys: string;
readonly behavioralAnalytics: string;
readonly behavioralAnalyticsCORS: string;
Expand Down Expand Up @@ -150,10 +153,6 @@ export interface DocLinks {
readonly documentLevelSecurity: string;
readonly elser: string;
readonly engines: string;
readonly esre: string;
readonly esreFaq: string;
readonly esreHelp: string;
readonly esreLearn: string;
readonly indexApi: string;
readonly ingestionApis: string;
readonly ingestPipelines: string;
Expand All @@ -170,6 +169,8 @@ export interface DocLinks {
readonly searchApplicationsSearchApi: string;
readonly searchApplications: string;
readonly searchApplicationsSearch: string;
readonly searchLabs: string;
readonly searchLabsRepo: string;
readonly searchTemplates: string;
readonly start: string;
readonly supportedNlpModels: string;
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ export const guideCards: GuideCardConstants[] = [
{
solution: 'search',
icon: 'magnifyWithPlus',
title: i18n.translate('guidedOnboardingPackage.gettingStarted.cards.esreSearch.title', {
title: i18n.translate('guidedOnboardingPackage.gettingStarted.cards.aiSearch.title', {
defaultMessage: 'Build a semantic search experience',
}),
navigateTo: {
appId: 'enterpriseSearchEsre',
appId: 'enterpriseSearchAISearch',
},
telemetryId: 'onboarding--search--semantic',
order: 4,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export const applicationUsageSchema = {
enterpriseSearchContent: commonSchema,
enterpriseSearchAnalytics: commonSchema,
enterpriseSearchApplications: commonSchema,
enterpriseSearchEsre: commonSchema,
enterpriseSearchAISearch: commonSchema,
enterpriseSearchVectorSearch: commonSchema,
enterpriseSearchElasticsearch: commonSchema,
appSearch: commonSchema,
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/telemetry/schema/oss_plugins.json
Original file line number Diff line number Diff line change
Expand Up @@ -2360,7 +2360,7 @@
}
}
},
"enterpriseSearchEsre": {
"enterpriseSearchAISearch": {
"properties": {
"appId": {
"type": "keyword",
Expand Down
16 changes: 8 additions & 8 deletions x-pack/plugins/enterprise_search/common/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,19 @@ export const ENTERPRISE_SEARCH_CONTENT_PLUGIN = {
SUPPORT_URL: 'https://discuss.elastic.co/c/enterprise-search/',
};

export const ESRE_PLUGIN = {
ID: 'enterpriseSearchEsre',
NAME: i18n.translate('xpack.enterpriseSearch.esre.productName', {
defaultMessage: 'ESRE',
export const AI_SEARCH_PLUGIN = {
ID: 'enterpriseSearchAISearch',
NAME: i18n.translate('xpack.enterpriseSearch.aiSearch.productName', {
defaultMessage: 'AI Search',
}),
NAV_TITLE: i18n.translate('xpack.enterpriseSearch.esre.navTitle', {
defaultMessage: 'ESRE',
NAV_TITLE: i18n.translate('xpack.enterpriseSearch.aiSearch.navTitle', {
defaultMessage: 'AI Search',
}),
DESCRIPTION: i18n.translate('xpack.enterpriseSearch.esre.description', {
DESCRIPTION: i18n.translate('xpack.enterpriseSearch.aiSearch.description', {
defaultMessage:
'Toolkit for enabling developers to build AI search-powered applications using the Elastic platform.',
}),
URL: '/app/enterprise_search/esre',
URL: '/app/enterprise_search/ai_search',
LOGO: 'logoEnterpriseSearch',
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ import { FormattedMessage } from '@kbn/i18n-react';

import { docLinks } from '../../../shared/doc_links';

export const EsreDocsSection: React.FC = () => (
export const SetAISearchChromeSearchDocsSection: React.FC = () => (
<EuiFlexGroup alignItems="center">
<EuiFlexItem grow={4}>
<EuiFlexGroup direction="column" gutterSize="s">
<EuiFlexItem grow={false}>
<EuiTitle>
<h2>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.title"
defaultMessage="Dive deeper with the ESRE docs"
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.title"
defaultMessage="Dive deeper with AI Search"
/>
</h2>
</EuiTitle>
Expand All @@ -32,20 +32,20 @@ export const EsreDocsSection: React.FC = () => (
<EuiText>
<p>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.description"
defaultMessage="To learn more about how to get started with ESRE, and test these tools with concrete examples, visit the {esreDocumentation}."
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.description"
defaultMessage="To learn more about how to get started and test these tools with concrete examples, visit {searchLab}."
values={{
esreDocumentation: (
searchLab: (
<EuiLink
data-telemetry-id="entSearch-esre-documentation-esreHomeLink"
data-telemetry-id="entSearch-aiSearch-documentation-searchLabsLink"
target="_blank"
href={docLinks.esre}
href={docLinks.searchLabs}
external
>
{i18n.translate(
'xpack.enterpriseSearch.esre.esreDocsSection.description.esreLinkText',
'xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.description.searchLabsLinkText',
{
defaultMessage: 'ESRE documentation',
defaultMessage: 'Search Labs',
}
)}
</EuiLink>
Expand All @@ -66,7 +66,7 @@ export const EsreDocsSection: React.FC = () => (
<EuiTitle size="s">
<h3>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.learn.title"
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.learn.title"
defaultMessage="Learn"
/>
</h3>
Expand All @@ -76,20 +76,20 @@ export const EsreDocsSection: React.FC = () => (
<EuiText>
<p>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.learn.description"
defaultMessage="These are complex subjects, so we've curated some {learningTopics} to help you get started."
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.learn.description"
defaultMessage="The {searchLabsRepo} has notebooks, sample apps, and resources."
values={{
learningTopics: (
searchLabsRepo: (
<EuiLink
data-telemetry-id="entSearch-esre-documentation-esreLearnLink"
data-telemetry-id="entSearch-aiSearch-documentation-searchLabsRepoLink"
target="_blank"
href={docLinks.esreLearn}
external={false}
href={docLinks.searchLabsRepo}
external
>
{i18n.translate(
'xpack.enterpriseSearch.esre.esreDocsSection.learn.learningTopicsLinkText',
'xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.learn.searchLabsRepoLinkText',
{
defaultMessage: 'learning topics',
defaultMessage: 'Search Labs Github repo',
}
)}
</EuiLink>
Expand All @@ -109,8 +109,8 @@ export const EsreDocsSection: React.FC = () => (
<EuiTitle size="s">
<h3>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.faq.title"
defaultMessage="FAQ"
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.doc.title"
defaultMessage="Docs"
/>
</h3>
</EuiTitle>
Expand All @@ -119,20 +119,20 @@ export const EsreDocsSection: React.FC = () => (
<EuiText>
<p>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.faq.description"
defaultMessage="Learn what ESRE is (and isn't) from these {frequentlyAskedQuestions}."
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.doc.description"
defaultMessage="Visit the {aiSearchDoc}."
values={{
frequentlyAskedQuestions: (
aiSearchDoc: (
<EuiLink
data-telemetry-id="entSearch-esre-documentation-esreFaqLink"
data-telemetry-id="entSearch-aiSearch-documentation-aiSearchDocLink"
target="_blank"
href={docLinks.esreFaq}
external={false}
href={docLinks.aiSearchDoc}
external
>
{i18n.translate(
'xpack.enterpriseSearch.esre.esreDocsSection.learn.frequentlyAskedQuestionsLinkText',
'xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.doc.aiSearchDocLinkText',
{
defaultMessage: 'frequently asked questions',
defaultMessage: 'Elastic documentation',
}
)}
</EuiLink>
Expand All @@ -152,7 +152,7 @@ export const EsreDocsSection: React.FC = () => (
<EuiTitle size="s">
<h3>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.help.title"
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.help.title"
defaultMessage="Help"
/>
</h3>
Expand All @@ -162,20 +162,20 @@ export const EsreDocsSection: React.FC = () => (
<EuiText>
<p>
<FormattedMessage
id="xpack.enterpriseSearch.esre.esreDocsSection.help.description"
id="xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.help.description"
defaultMessage="Need help? Check out the {discussForum}!"
values={{
discussForum: (
<EuiLink
data-telemetry-id="entSearch-esre-documentation-esreHelpLink"
data-telemetry-id="entSearch-aiSearch-documentation-aiSearchHelpLink"
target="_blank"
href={docLinks.esreHelp}
href={docLinks.aiSearchHelp}
external={false}
>
{i18n.translate(
'xpack.enterpriseSearch.esre.esreDocsSection.learn.discussForumLinkText',
'xpack.enterpriseSearch.aiSearch.aiSearchDocsSection.help.helpLinkText',
{
defaultMessage: 'ESRE discuss forum',
defaultMessage: 'discuss forum or Elastic community Slack',
}
)}
</EuiLink>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,24 @@ import { FormattedMessage } from '@kbn/i18n-react';
import analyticsIllustration from '../../../../assets/images/analytics.svg';
import scalableIllustration from '../../../../assets/images/scalable.svg';
import simplifyIllustration from '../../../../assets/images/simplify.svg';
import { SetEsreChrome as SetPageChrome } from '../../../shared/kibana_chrome';
import { EnterpriseSearchEsrePageTemplate } from '../layout/page_template';
import { SetAiSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';
import { EnterpriseSearchAISearchPageTemplate } from '../layout/page_template';

import { EsreDocsSection } from './esre_docs_section';
import { SetAISearchChromeSearchDocsSection } from './ai_search_docs_section';
import { MeasurePerformanceSection } from './measure_performance_section';
import { RankAggregationSection } from './rank_aggregation_section';
import { SemanticSearchSection } from './semantic_search_section';

export const EsreGuide: React.FC = () => {
export const AISearchGuide: React.FC = () => {
const isMobile = useIsWithinBreakpoints(['xs']);

return (
<EnterpriseSearchEsrePageTemplate
<EnterpriseSearchAISearchPageTemplate
restrictWidth
bottomBorder={false}
pageHeader={{
pageTitle: i18n.translate('xpack.enterpriseSearch.esre.guide.pageTitle', {
defaultMessage: 'Enhance your search with ESRE',
pageTitle: i18n.translate('xpack.enterpriseSearch.aiSearch.guide.pageTitle', {
defaultMessage: 'Enhance your search with AI',
}),
}}
>
Expand All @@ -64,10 +64,10 @@ export const EsreGuide: React.FC = () => {
</EuiFlexItem>
<EuiFlexItem grow>
<EuiText>
<p data-test-subj="esre-description-text">
<p data-test-subj="ai-search-description-text">
<FormattedMessage
id="xpack.enterpriseSearch.esre.guide.description"
defaultMessage="The Elasticsearch Relevance Engine™ (ESRE) enables developers to build AI search-powered applications using the Elastic platform. ESRE is a set of tools and features that include our proprietary trained ML model ELSER, our vector search and embeddings capabilities, and RRF ranking for combining vector and text search."
id="xpack.enterpriseSearch.aiSearch.guide.description"
defaultMessage="Build AI search-powered applications using the Elastic platform, including our proprietary trained ML model ELSER, our vector search and embeddings capabilities, and RRF ranking for combining vector and text search."
/>
</p>
</EuiText>
Expand All @@ -85,10 +85,10 @@ export const EsreGuide: React.FC = () => {
</EuiFlexItem>
<EuiHorizontalRule />
<EuiFlexItem grow>
<EsreDocsSection />
<SetAISearchChromeSearchDocsSection />
</EuiFlexItem>
</EuiFlexGroup>
</EuiPanel>
</EnterpriseSearchEsrePageTemplate>
</EnterpriseSearchAISearchPageTemplate>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
EuiPanel,
} from '@elastic/eui';

export interface EsreGuideAccordionProps {
export interface AISearchGuideAccordionProps {
id: string;
icon: IconType;
title: string;
Expand All @@ -28,7 +28,7 @@ export interface EsreGuideAccordionProps {
currentExpandedId: string | undefined;
}

export const EsreGuideAccordion: React.FC<EsreGuideAccordionProps> = ({
export const AISearchGuideAccordion: React.FC<AISearchGuideAccordionProps> = ({
id,
icon,
title,
Expand Down
Loading
Loading