Automated update to repo's documentation from github action

yext · Jul 12, 2024 · 9a57623 · 9a57623
1 parent 88ee0e7
commit 9a57623
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/docs/search-core.segment.md b/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 a segment from a pdf |
 |  [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. |
 
diff --git a/docs/search-core.segment.pagenumber.md b/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 a segment from a pdf
+
+<b>Signature:</b>
+
+```typescript
+pageNumber?: number;
+```
diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -692,6 +692,7 @@ export interface SearchService {
 
 // @public
 export interface Segment {
+    pageNumber?: number;
     score: number;
     text: string;
 }