Skip to content

Commit

Permalink
Merge pull request #269 from yext/hotfix/v2.5.2
Browse files Browse the repository at this point in the history
Version v2.5.2
  • Loading branch information
vdarosa authored Jul 15, 2024
2 parents 54b5cc7 + 666306d commit 09b19f5
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 4 deletions.
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 @@ -692,6 +692,7 @@ export interface SearchService {

// @public
export interface Segment {
pageNumber?: number;
score: number;
text: string;
}
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@yext/search-core",
"version": "2.5.1",
"version": "2.5.2",
"description": "Typescript Networking Library for the Yext Search API",
"main": "./dist/commonjs/src/index.js",
"module": "./dist/esm/src/index.js",
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
}

0 comments on commit 09b19f5

Please sign in to comment.