-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
212 additions
and
52 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
docs/search-core.basefeaturedsnippetdirectanswer.fieldtype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) > [fieldType](./search-core.basefeaturedsnippetdirectanswer.fieldtype.md) | ||
|
|
||
| ## BaseFeaturedSnippetDirectAnswer.fieldType property | ||
|
|
||
| The field type of the direct answer. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) | ||
|
|
||
| ## BaseFeaturedSnippetDirectAnswer interface | ||
|
|
||
| A direct answer which was found within a document. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> | ||
| ``` | ||
| <b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- --><T> | ||
| ## Properties | ||
| | Property | Type | Description | | ||
| | --- | --- | --- | | ||
| | [fieldType](./search-core.basefeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- --><[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)<!-- -->> | The field type of the direct answer. | | ||
| | [snippet](./search-core.basefeaturedsnippetdirectanswer.snippet.md) | [Snippet](./search-core.snippet.md) | The snippet where the direct answer was found. | | ||
| | [type](./search-core.basefeaturedsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FeaturedSnippet | | ||
4 changes: 2 additions & 2 deletions
4
...re.featuredsnippetdirectanswer.snippet.md → ...asefeaturedsnippetdirectanswer.snippet.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...-core.featuredsnippetdirectanswer.type.md → ...e.basefeaturedsnippetdirectanswer.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) > [fieldType](./search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md) | ||
|
|
||
| ## MultiLineTextFeaturedSnippetDirectAnswer.fieldType property | ||
|
|
||
| The field type of the direct answer. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText>; | ||
| ``` |
22 changes: 22 additions & 0 deletions
22
docs/search-core.multilinetextfeaturedsnippetdirectanswer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) | ||
|
|
||
| ## MultiLineTextFeaturedSnippetDirectAnswer interface | ||
|
|
||
| A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string> | ||
| ``` | ||
| <b>Extends:</b> [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<!-- --><string> | ||
| ## Properties | ||
| | Property | Type | Description | | ||
| | --- | --- | --- | | ||
| | [fieldType](./search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- --><[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md)<!-- -->> | The field type of the direct answer. | | ||
| | [value](./search-core.multilinetextfeaturedsnippetdirectanswer.value.md) | string | The value of the direct answer. | | ||
13 changes: 13 additions & 0 deletions
13
docs/search-core.multilinetextfeaturedsnippetdirectanswer.value.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) > [value](./search-core.multilinetextfeaturedsnippetdirectanswer.value.md) | ||
|
|
||
| ## MultiLineTextFeaturedSnippetDirectAnswer.value property | ||
|
|
||
| The value of the direct answer. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| value: string; | ||
| ``` |
13 changes: 13 additions & 0 deletions
13
docs/search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) > [fieldType](./search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md) | ||
|
|
||
| ## RichTextFeaturedSnippetDirectAnswer.fieldType property | ||
|
|
||
| The field type of the direct answer. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| fieldType: EnumOrLiteral<BuiltInFieldType.RichText>; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [@yext/search-core](./search-core.md) > [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) | ||
|
|
||
| ## RichTextFeaturedSnippetDirectAnswer interface | ||
|
|
||
| A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| export interface RichTextFeaturedSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> | ||
| ``` | ||
| <b>Extends:</b> Omit<[BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<!-- --><string>, 'value'> | ||
| ## Properties | ||
| | Property | Type | Description | | ||
| | --- | --- | --- | | ||
| | [fieldType](./search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- --><[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)<!-- -->> | The field type of the direct answer. | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
src/models/searchservice/response/directanswer/BaseFeaturedSnippetDirectAnswer.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import { DirectAnswer } from './DirectAnswer'; | ||
| import { DirectAnswerType } from './DirectAnswerType'; | ||
| import { Snippet } from '../Snippet'; | ||
| import { BuiltInFieldType } from './BuiltInFieldType'; | ||
| import { EnumOrLiteral } from '../../../utils/EnumOrLiteral'; | ||
|
|
||
| /** | ||
| * A direct answer which was found within a document. | ||
| * | ||
| * @public | ||
| */ | ||
| export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> { | ||
| /** {@link DirectAnswerType}.FeaturedSnippet */ | ||
| type: DirectAnswerType.FeaturedSnippet, | ||
| /** {@inheritDoc DirectAnswer.fieldType} */ | ||
| fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>, | ||
| /** The snippet where the direct answer was found. */ | ||
| snippet: Snippet | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.