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

Merge master (v2.5.2) into develop #270

Merged
merged 9 commits into from
Jul 17, 2024
1 change: 1 addition & 0 deletions docs/search-core.segment.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface Segment

| Property | Type | Description |
| --- | --- | --- |
| [pageNumber?](./search-core.segment.pagenumber.md) | number | <i>(Optional)</i> The page number of the document that the segment came from. Populated only for pdf files. |
| [score](./search-core.segment.score.md) | number | The similarity score of the segment from 0 to 1 |
| [text](./search-core.segment.text.md) | string | The value of the segment as plain text. |

13 changes: 13 additions & 0 deletions docs/search-core.segment.pagenumber.md
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) &gt; [@yext/search-core](./search-core.md) &gt; [Segment](./search-core.segment.md) &gt; [pageNumber](./search-core.segment.pagenumber.md)

## Segment.pageNumber property

The page number of the document that the segment came from. Populated only for pdf files.

<b>Signature:</b>

```typescript
pageNumber?: number;
```
1 change: 1 addition & 0 deletions etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -714,6 +714,7 @@ export interface SearchService {

// @public
export interface Segment {
pageNumber?: number;
score: number;
text: string;
}
Expand Down
4 changes: 3 additions & 1 deletion src/models/searchservice/response/Segment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ export interface Segment {
/** The value of the segment as plain text. */
text: string,
/** The similarity score of the segment from 0 to 1 */
score: number
score: number,
/** The page number of the document that the segment came from. Populated only for pdf files. */
pageNumber?: number
}
Loading