-
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
62 changed files
with
662 additions
and
314 deletions.
There are no files selected for viewing
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
4 changes: 2 additions & 2 deletions
4
...core.fieldvaluedirectanswer.entityname.md → ....basefieldvaluedirectanswer.entityname.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
...re.fieldvaluedirectanswer.fieldapiname.md → ...asefieldvaluedirectanswer.fieldapiname.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.fieldvaluedirectanswer.fieldname.md → ...e.basefieldvaluedirectanswer.fieldname.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 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,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) | ||
|
||
## BaseFieldValueDirectAnswer interface | ||
|
||
A direct answer where the answer came from a field from the knowledge graph. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface BaseFieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> | ||
``` | ||
<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- --><T> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [entityName](./search-core.basefieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | | ||
| [fieldApiName](./search-core.basefieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | | ||
| [fieldName](./search-core.basefieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | | ||
| [type](./search-core.basefieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FieldValue. | | ||
| [value](./search-core.basefieldvaluedirectanswer.value.md) | T | The result of the direct answer. | | ||
4 changes: 2 additions & 2 deletions
4
...earch-core.fieldvaluedirectanswer.type.md → ...h-core.basefieldvaluedirectanswer.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 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) > [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) > [value](./search-core.basefieldvaluedirectanswer.value.md) | ||
|
||
## BaseFieldValueDirectAnswer.value property | ||
|
||
The result of the direct answer. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
value: T; | ||
``` |
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
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) > [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) > [combinator](./search-core.conjunctionstaticfilter.combinator.md) | ||
|
||
## ConjunctionStaticFilter.combinator property | ||
|
||
Indicates that filters should be combined with a logical AND. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
combinator: FilterCombinator.AND; | ||
``` |
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) > [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) > [filters](./search-core.conjunctionstaticfilter.filters.md) | ||
|
||
## ConjunctionStaticFilter.filters property | ||
|
||
The filters to combine together. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
filters: StaticFilter[]; | ||
``` |
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) > [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) > [kind](./search-core.conjunctionstaticfilter.kind.md) | ||
|
||
## ConjunctionStaticFilter.kind property | ||
|
||
The kind of static filter. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
kind: 'conjunction'; | ||
``` |
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) > [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) | ||
|
||
## ConjunctionStaticFilter interface | ||
|
||
A static filter composed by combining other static filters with the logical AND operator. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ConjunctionStaticFilter | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [combinator](./search-core.conjunctionstaticfilter.combinator.md) | [FilterCombinator.AND](./search-core.filtercombinator.md) | Indicates that filters should be combined with a logical AND. | | ||
| [filters](./search-core.conjunctionstaticfilter.filters.md) | [StaticFilter](./search-core.staticfilter.md)<!-- -->\[\] | The filters to combine together. | | ||
| [kind](./search-core.conjunctionstaticfilter.kind.md) | 'conjunction' | The kind of static filter. | | ||
|
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
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
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) > [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) > [combinator](./search-core.disjunctionstaticfilter.combinator.md) | ||
|
||
## DisjunctionStaticFilter.combinator property | ||
|
||
Indicates that filters should be combined with a logical OR. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
combinator: FilterCombinator.OR; | ||
``` |
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) > [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) > [filters](./search-core.disjunctionstaticfilter.filters.md) | ||
|
||
## DisjunctionStaticFilter.filters property | ||
|
||
The filters to combine together. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
filters: (DisjunctionStaticFilter | FieldValueStaticFilter)[]; | ||
``` |
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) > [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) > [kind](./search-core.disjunctionstaticfilter.kind.md) | ||
|
||
## DisjunctionStaticFilter.kind property | ||
|
||
The kind of static filter. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
kind: 'disjunction'; | ||
``` |
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) > [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) | ||
|
||
## DisjunctionStaticFilter interface | ||
|
||
A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface DisjunctionStaticFilter | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [combinator](./search-core.disjunctionstaticfilter.combinator.md) | [FilterCombinator.OR](./search-core.filtercombinator.md) | Indicates that filters should be combined with a logical OR. | | ||
| [filters](./search-core.disjunctionstaticfilter.filters.md) | ([DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) \| [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)<!-- -->)\[\] | The filters to combine together. | | ||
| [kind](./search-core.disjunctionstaticfilter.kind.md) | 'disjunction' | The kind of static filter. | | ||
|
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) > [EnumOrLiteral](./search-core.enumorliteral.md) | ||
|
||
## EnumOrLiteral type | ||
|
||
Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type EnumOrLiteral<T extends string> = T | `${T}`; | ||
``` |
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: 0 additions & 13 deletions
13
docs/search-core.featuredsnippetdirectanswer.relatedresult.md
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 was deleted.
Oops, something went wrong.
13 changes: 0 additions & 13 deletions
13
docs/search-core.featuredsnippetdirectanswer.verticalkey.md
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.