Skip to content

Commit

Permalink
bump core version
Browse files Browse the repository at this point in the history
  • Loading branch information
cea2aj committed Sep 29, 2023
1 parent 272624f commit 74f18af
Show file tree
Hide file tree
Showing 12 changed files with 108 additions and 138 deletions.
21 changes: 0 additions & 21 deletions docs/search-headless.document_2.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Document\_2](./search-headless.document_2.md) &gt; [documentScore](./search-headless.document_2.documentscore.md)
[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [DocumentResult](./search-headless.documentresult.md) &gt; [documentScore](./search-headless.documentresult.documentscore.md)

## Document\_2.documentScore property
## DocumentResult.documentScore property

The score calculated from whatever document search strategy was used.

Expand Down
21 changes: 21 additions & 0 deletions docs/search-headless.documentresult.md
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) &gt; [@yext/search-headless](./search-headless.md) &gt; [DocumentResult](./search-headless.documentresult.md)

## DocumentResult interface

Details about the document and the document search algorithm

<b>Signature:</b>

```typescript
export declare interface DocumentResult
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [documentScore](./search-headless.documentresult.documentscore.md) | number | The score calculated from whatever document search strategy was used. |
| [segments](./search-headless.documentresult.segments.md) | [Segment](./search-headless.segment.md)<!-- -->\[\] | All the relevant segments extracted from the document. |

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Document\_2](./search-headless.document_2.md) &gt; [segments](./search-headless.document_2.segments.md)
[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [DocumentResult](./search-headless.documentresult.md) &gt; [segments](./search-headless.documentresult.segments.md)

## Document\_2.segments property
## DocumentResult.segments property

All the relevant segments extracted from the document.

Expand Down
2 changes: 1 addition & 1 deletion docs/search-headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
| [DisjunctionStaticFilter](./search-headless.disjunctionstaticfilter.md) | 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. |
| [DisplayableFacet](./search-headless.displayablefacet.md) | A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. |
| [DisplayableFacetOption](./search-headless.displayablefacetoption.md) | A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. |
| [Document\_2](./search-headless.document_2.md) | Details about the document and the document search algorithm |
| [DocumentResult](./search-headless.documentresult.md) | Details about the document and the document search algorithm |
| [EmailDirectAnswer](./search-headless.emaildirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'email' field type. |
| [Endpoints](./search-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. |
| [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md) | A direct answer for a facebook url field. |
Expand Down
2 changes: 1 addition & 1 deletion docs/search-headless.result.document.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ A relevant document associated with the result. Present for document verticals g
<b>Signature:</b>

```typescript
document?: Document_2;
document?: DocumentResult;
```
2 changes: 1 addition & 1 deletion docs/search-headless.result.documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ All relevant documents associated with the result. Present for document vertical
<b>Signature:</b>

```typescript
documents?: Document_2[];
documents?: DocumentResult[];
```
4 changes: 2 additions & 2 deletions docs/search-headless.result.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ export declare interface Result<T = Record<string, unknown>>
| [description?](./search-headless.result.description.md) | string | <i>(Optional)</i> A description of the result. |
| [distance?](./search-headless.result.distance.md) | number | <i>(Optional)</i> The distance from the user to the result in meters. |
| [distanceFromFilter?](./search-headless.result.distancefromfilter.md) | number | <i>(Optional)</i> The distance from a [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) location to the result in meters. |
| [document?](./search-headless.result.document.md) | Document\_2 | <i>(Optional)</i> A relevant document associated with the result. Present for document verticals grouped by Document. |
| [documents?](./search-headless.result.documents.md) | Document\_2\[\] | <i>(Optional)</i> All relevant documents associated with the result. Present for document verticals grouped by Entity. |
| [document?](./search-headless.result.document.md) | [DocumentResult](./search-headless.documentresult.md) | <i>(Optional)</i> A relevant document associated with the result. Present for document verticals grouped by Document. |
| [documents?](./search-headless.result.documents.md) | [DocumentResult](./search-headless.documentresult.md)<!-- -->\[\] | <i>(Optional)</i> All relevant documents associated with the result. Present for document verticals grouped by Entity. |
| [entityType?](./search-headless.result.entitytype.md) | string | <i>(Optional)</i> The entity type of the result. |
| [highlightedFields?](./search-headless.result.highlightedfields.md) | [HighlightedFields](./search-headless.highlightedfields.md) | <i>(Optional)</i> The [highlighted fields](./search-headless.highlightedfields.md) emphasized by the api. |
| [id?](./search-headless.result.id.md) | string | <i>(Optional)</i> The result ID which depends on the Result Source. |
Expand Down
7 changes: 3 additions & 4 deletions etc/search-headless.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,11 +294,10 @@ export interface DisplayableFacetOption extends FacetOption {
}

// @public
interface Document_2 {
export interface DocumentResult {
documentScore: number;
segments: Segment[];
}
export { Document_2 as Document }

// @public
export interface EmailDirectAnswer extends BaseFieldValueDirectAnswer<string[]> {
Expand Down Expand Up @@ -699,8 +698,8 @@ export interface Result<T = Record<string, unknown>> {
description?: string;
distance?: number;
distanceFromFilter?: number;
document?: Document_2;
documents?: Document_2[];
document?: DocumentResult;
documents?: DocumentResult[];
entityType?: string;
highlightedFields?: HighlightedFields;
id?: string;
Expand Down
173 changes: 72 additions & 101 deletions package-lock.json

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

Loading

0 comments on commit 74f18af

Please sign in to comment.