search-core: Adding Page Number to Segment (#268)

* search-core: Adding Page Number to Segment

Added an optional parameter called pageNumber to Segments.ts

* Automated update to repo's documentation from github action

* description: changed the description of the pageNumber variable

* Automated update to repo's documentation from github action

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

docs/search-core.segment.md

@@ -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. |
 

docs/search-core.segment.pagenumber.md

@@ -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;
+```

etc/search-core.api.md

@@ -692,6 +692,7 @@ export interface SearchService {
 
 // @public
 export interface Segment {
+    pageNumber?: number;
     score: number;
     text: string;
 }

src/models/searchservice/response/Segment.ts

@@ -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
 }