@aventurevc/api-schemas 0.8.375 → 0.8.376

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (205) hide show
  1. package/dist/address/address.d.ts +1 -1
  2. package/dist/address/address.js +1 -1
  3. package/dist/agent/task-preset-catalog.js +1 -1
  4. package/dist/agent/task-preset-phase.d.ts +1 -1
  5. package/dist/agent/task-preset-phase.js +1 -1
  6. package/dist/agent/task-preset.js +1 -1
  7. package/dist/auth/operation-authorization.d.ts +1 -1
  8. package/dist/auth/operation-authorization.js +2 -2
  9. package/dist/blog/post-type.d.ts +1 -1
  10. package/dist/blog/post-type.js +1 -1
  11. package/dist/blog/post.d.ts +1 -1
  12. package/dist/blog/post.js +2 -2
  13. package/dist/classification/catalog-bucket.js +1 -1
  14. package/dist/classification/catalog-category.js +1 -1
  15. package/dist/classification/join-registry.d.ts +1 -1
  16. package/dist/classification/join-registry.js +1 -1
  17. package/dist/cli/authorization-poll.js +1 -1
  18. package/dist/cli/authorization.js +1 -1
  19. package/dist/content/compliance.d.ts +1 -1
  20. package/dist/content/compliance.js +2 -2
  21. package/dist/content/embedding-match.d.ts +1 -1
  22. package/dist/content/embedding-match.js +3 -3
  23. package/dist/content/source-type.d.ts +1 -1
  24. package/dist/content/source-type.js +1 -1
  25. package/dist/datasource/source-metadata.d.ts +1 -1
  26. package/dist/datasource/source-metadata.js +1 -1
  27. package/dist/enrichment/batch.js +2 -2
  28. package/dist/entity/accelerator-participation.d.ts +1 -1
  29. package/dist/entity/accelerator-participation.js +3 -3
  30. package/dist/entity/acquisition.js +5 -5
  31. package/dist/entity/analysis-replay.js +1 -1
  32. package/dist/entity/brand.d.ts +1 -1
  33. package/dist/entity/brand.js +1 -1
  34. package/dist/entity/comparison-signals.d.ts +1 -1
  35. package/dist/entity/comparison-signals.js +1 -1
  36. package/dist/entity/detail.d.ts +1 -1
  37. package/dist/entity/detail.js +3 -3
  38. package/dist/entity/entity.d.ts +1 -1
  39. package/dist/entity/entity.js +3 -3
  40. package/dist/entity/filter-control-type.d.ts +1 -1
  41. package/dist/entity/filter-control-type.js +1 -1
  42. package/dist/entity/filter-meta.d.ts +1 -1
  43. package/dist/entity/filter-meta.js +2 -2
  44. package/dist/entity/filter-option-set-meta.d.ts +1 -1
  45. package/dist/entity/filter-option-set-meta.js +1 -1
  46. package/dist/entity/filter-request-value-shape.d.ts +1 -1
  47. package/dist/entity/filter-request-value-shape.js +1 -1
  48. package/dist/entity/filter.js +6 -6
  49. package/dist/entity/fundraise-investor-join.d.ts +1 -1
  50. package/dist/entity/fundraise-investor-join.js +1 -1
  51. package/dist/entity/fundraise-transaction-entity.d.ts +1 -1
  52. package/dist/entity/fundraise-transaction-entity.js +1 -1
  53. package/dist/entity/fundraise-transaction.d.ts +1 -1
  54. package/dist/entity/fundraise-transaction.js +2 -2
  55. package/dist/entity/fundraise.js +1 -1
  56. package/dist/entity/list-filter.js +6 -6
  57. package/dist/entity/list-quality-gate.d.ts +1 -1
  58. package/dist/entity/list-quality-gate.js +1 -1
  59. package/dist/entity/list-research.d.ts +1 -1
  60. package/dist/entity/list-research.js +3 -3
  61. package/dist/entity/list.d.ts +1 -1
  62. package/dist/entity/list.js +4 -4
  63. package/dist/entity/natural-search.js +1 -1
  64. package/dist/entity/person-association.js +11 -11
  65. package/dist/entity/provider.d.ts +1 -1
  66. package/dist/entity/provider.js +1 -1
  67. package/dist/entity/relationship-type-option.js +2 -2
  68. package/dist/entity/relationship.d.ts +1 -1
  69. package/dist/entity/relationship.js +2 -2
  70. package/dist/entity/research-detail.js +1 -1
  71. package/dist/entity/research-fact-value.d.ts +1 -1
  72. package/dist/entity/research-fact-value.js +2 -2
  73. package/dist/entity/research-snippet.js +2 -2
  74. package/dist/entity/research-value-type.d.ts +1 -1
  75. package/dist/entity/research-value-type.js +1 -1
  76. package/dist/entity/research.d.ts +1 -1
  77. package/dist/entity/research.js +3 -3
  78. package/dist/entity/similarity-summary.d.ts +1 -1
  79. package/dist/entity/similarity-summary.js +1 -1
  80. package/dist/entity/sitemap.js +5 -5
  81. package/dist/entity/tag.js +1 -1
  82. package/dist/entity/text.d.ts +1 -1
  83. package/dist/entity/text.js +4 -4
  84. package/dist/entity/type-alias.d.ts +1 -1
  85. package/dist/entity/type-alias.js +2 -2
  86. package/dist/entity/type-group-membership.d.ts +1 -1
  87. package/dist/entity/type-group-membership.js +1 -1
  88. package/dist/entity/type-group.d.ts +1 -1
  89. package/dist/entity/type-group.js +1 -1
  90. package/dist/entity/type.d.ts +1 -1
  91. package/dist/entity/type.js +1 -1
  92. package/dist/entity/url-link.d.ts +1 -1
  93. package/dist/entity/url-link.js +2 -2
  94. package/dist/entity/valuation-source.d.ts +1 -1
  95. package/dist/entity/valuation-source.js +1 -1
  96. package/dist/entity/valuation-time-series-point.js +2 -2
  97. package/dist/federated/search-provenance.js +3 -3
  98. package/dist/federated/search.d.ts +1 -1
  99. package/dist/federated/search.js +2 -2
  100. package/dist/fundraise/investment-evidence.d.ts +1 -1
  101. package/dist/fundraise/investment-evidence.js +1 -1
  102. package/dist/github/repo.js +1 -1
  103. package/dist/harness/chassis.d.ts +1 -1
  104. package/dist/harness/chassis.js +1 -1
  105. package/dist/harness/llm-api.d.ts +1 -1
  106. package/dist/harness/llm-api.js +1 -1
  107. package/dist/harness/research-outcome.d.ts +1 -1
  108. package/dist/harness/research-outcome.js +1 -1
  109. package/dist/harness/run-detail.js +1 -1
  110. package/dist/harness/run-event.js +1 -1
  111. package/dist/harness/run-follow-up-admission.d.ts +1 -1
  112. package/dist/harness/run-follow-up-admission.js +1 -1
  113. package/dist/harness/run-follow-up.d.ts +1 -1
  114. package/dist/harness/run-follow-up.js +4 -4
  115. package/dist/harness/run-lane.d.ts +1 -1
  116. package/dist/harness/run-lane.js +1 -1
  117. package/dist/harness/run-progress.js +1 -1
  118. package/dist/harness/run.js +9 -9
  119. package/dist/harness/task-input-binding.js +2 -2
  120. package/dist/harness/task-input-type.d.ts +1 -1
  121. package/dist/harness/task-input-type.js +1 -1
  122. package/dist/harness/task-plan.js +1 -1
  123. package/dist/harness/task-write-guidance.js +1 -1
  124. package/dist/help/source-type.d.ts +1 -1
  125. package/dist/help/source-type.js +1 -1
  126. package/dist/http/problem-detail.js +2 -2
  127. package/dist/identification/candidate.js +2 -2
  128. package/dist/identification/identification.js +2 -2
  129. package/dist/investor/portfolio-recipient.d.ts +1 -1
  130. package/dist/investor/portfolio-recipient.js +1 -1
  131. package/dist/lookup/job.js +2 -2
  132. package/dist/lookup/source-read.d.ts +1 -1
  133. package/dist/lookup/source-read.js +2 -2
  134. package/dist/natural/search-result.d.ts +1 -1
  135. package/dist/natural/search-result.js +3 -3
  136. package/dist/natural/search.d.ts +1 -1
  137. package/dist/natural/search.js +1 -1
  138. package/dist/news/analysis.js +1 -1
  139. package/dist/news/detail.d.ts +1 -1
  140. package/dist/news/detail.js +1 -1
  141. package/dist/news/news.d.ts +1 -1
  142. package/dist/news/news.js +3 -3
  143. package/dist/news/resolved-entity-link.js +2 -2
  144. package/dist/news/resolved-person-link.js +2 -2
  145. package/dist/news/source-url-conflict.js +1 -1
  146. package/dist/person/detail.d.ts +1 -1
  147. package/dist/person/detail.js +1 -1
  148. package/dist/person/filter.d.ts +1 -1
  149. package/dist/person/filter.js +1 -1
  150. package/dist/person/graph-career-context.js +2 -2
  151. package/dist/person/graph-co-investor.js +2 -2
  152. package/dist/person/graph-member.d.ts +1 -1
  153. package/dist/person/graph-member.js +4 -4
  154. package/dist/person/graph-similar-entity.js +1 -1
  155. package/dist/person/graph.d.ts +1 -1
  156. package/dist/person/graph.js +1 -1
  157. package/dist/person/image.d.ts +1 -1
  158. package/dist/person/image.js +1 -1
  159. package/dist/person/investment.d.ts +1 -1
  160. package/dist/person/investment.js +2 -2
  161. package/dist/person/lookup-exact-param.js +4 -4
  162. package/dist/person/natural-search-result.d.ts +1 -1
  163. package/dist/person/natural-search-result.js +2 -2
  164. package/dist/person/natural-search.js +1 -1
  165. package/dist/person/person.d.ts +1 -1
  166. package/dist/person/person.js +5 -5
  167. package/dist/redirect/current-slug-owner.d.ts +1 -1
  168. package/dist/redirect/current-slug-owner.js +1 -1
  169. package/dist/research/allowance-usage.js +1 -1
  170. package/dist/research/derived-range.d.ts +1 -1
  171. package/dist/research/derived-range.js +1 -1
  172. package/dist/research/detail-type.js +1 -1
  173. package/dist/research/paragraph-shape.d.ts +1 -1
  174. package/dist/research/paragraph-shape.js +1 -1
  175. package/dist/research/snippet-type.d.ts +1 -1
  176. package/dist/research/snippet-type.js +3 -3
  177. package/dist/search/cache-mode.d.ts +1 -1
  178. package/dist/search/cache-mode.js +1 -1
  179. package/dist/search/investment.d.ts +1 -1
  180. package/dist/search/investment.js +1 -1
  181. package/dist/search/mode-execution.d.ts +1 -1
  182. package/dist/search/mode-execution.js +2 -2
  183. package/dist/sec/company.js +1 -1
  184. package/dist/shared/directory-list.js +1 -1
  185. package/dist/shared/search-list.js +1 -1
  186. package/dist/source/document-list.d.ts +1 -1
  187. package/dist/source/document-list.js +3 -3
  188. package/dist/stage/frequency.d.ts +1 -1
  189. package/dist/stage/frequency.js +1 -1
  190. package/dist/standardized/classification-filter.js +1 -1
  191. package/dist/text/type-option.d.ts +1 -1
  192. package/dist/text/type-option.js +5 -5
  193. package/dist/unique/id-mutation.js +1 -1
  194. package/dist/unique/id-type-alias.d.ts +1 -1
  195. package/dist/unique/id-type-alias.js +3 -3
  196. package/dist/unique/id.js +1 -1
  197. package/dist/url/duplicate-conflict.js +2 -2
  198. package/dist/url/duplicate-join.d.ts +1 -1
  199. package/dist/url/duplicate-join.js +1 -1
  200. package/dist/url/type-alias.d.ts +1 -1
  201. package/dist/url/type-alias.js +2 -2
  202. package/dist/web/search.js +1 -1
  203. package/dist/writer/claim-surface.d.ts +1 -1
  204. package/dist/writer/claim-surface.js +1 -1
  205. package/package.json +1 -1
@@ -11,7 +11,7 @@ type EntityTypeAliasDefinition = z.infer<typeof EntityTypeAliasSchemaDefinition>
11
11
  export interface EntityTypeAliasSchemaInput extends z.input<typeof EntityTypeAliasSchemaDefinition> {
12
12
  }
13
13
  /**
14
- * Canonical EntityType value, accepted aliases, and public routing metadata.
14
+ * An entity type, its accepted alternative spellings, and how its public pages are addressed.
15
15
  *
16
16
  * @openapiSchema EntityTypeAlias
17
17
  * @endpoint GET /v1/entities/types
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  const EntityTypeAliasSchemaDefinition = z.object({
4
- /** Alias tokens accepted by EntityType.fromRaw (case-insensitive). */
4
+ /** Other spellings accepted for this entity type (case-insensitive). */
5
5
  alias: z.array(z.string()),
6
6
  /** Canonical EntityType value (e.g. "Company", "Investment Firm"). */
7
7
  canonical: z.string(),
@@ -15,7 +15,7 @@ const EntityTypeAliasSchemaDefinition = z.object({
15
15
  publicPathPrefix: z.string(),
16
16
  });
17
17
  /**
18
- * Canonical EntityType value, accepted aliases, and public routing metadata.
18
+ * An entity type, its accepted alternative spellings, and how its public pages are addressed.
19
19
  *
20
20
  * @openapiSchema EntityTypeAlias
21
21
  * @endpoint GET /v1/entities/types
@@ -20,7 +20,7 @@ type EntityTypeGroupMembershipDefinition = z.infer<typeof EntityTypeGroupMembers
20
20
  export interface EntityTypeGroupMembershipSchemaInput extends z.input<typeof EntityTypeGroupMembershipSchemaDefinition> {
21
21
  }
22
22
  /**
23
- * Canonical concrete entity types included by one entity type group.
23
+ * Entity types included in one entity type group.
24
24
  *
25
25
  * @openapiSchema EntityTypeGroupMembership
26
26
  * @endpoint GET /v1/entities/filters
@@ -7,7 +7,7 @@ const EntityTypeGroupMembershipSchemaDefinition = z.object({
7
7
  typeRecord: z.array(EntityTypeSchema),
8
8
  });
9
9
  /**
10
- * Canonical concrete entity types included by one entity type group.
10
+ * Entity types included in one entity type group.
11
11
  *
12
12
  * @openapiSchema EntityTypeGroupMembership
13
13
  * @endpoint GET /v1/entities/filters
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Canonical entity type groups for boundary-level scope selection.
3
+ * Groups of entity types, such as Organization, that a filter can select at once.
4
4
  *
5
5
  * @openapiSchema EntityTypeGroup
6
6
  * @endpoint GET /v1/entities/filters
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Canonical entity type groups for boundary-level scope selection.
4
+ * Groups of entity types, such as Organization, that a filter can select at once.
5
5
  *
6
6
  * @openapiSchema EntityTypeGroup
7
7
  * @endpoint GET /v1/entities/filters
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Canonical entity classification for the organization, product, and service records stored in the entity domain.
3
+ * Kind of entity: an organization type such as Company or Investment Firm, or a Product or Service.
4
4
  *
5
5
  * @openapiSchema EntityType
6
6
  * @standardProblemResponse
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Canonical entity classification for the organization, product, and service records stored in the entity domain.
4
+ * Kind of entity: an organization type such as Company or Investment Firm, or a Product or Service.
5
5
  *
6
6
  * @openapiSchema EntityType
7
7
  * @standardProblemResponse
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Canonical URL link resource with owner, status, crawl, and source metadata. Lifecycle state (current vs former, primary vs secondary) is encoded by `isCurrent` and `isPrimary` — `urlType` is the canonical platform role only and write values come from GET /v1/url-types. Readers accept new platform roles as deployments evolve. To record a rebrand or domain migration, retain the prior URL with the same `urlType` (typically `website`) and set `isCurrent=false, isPrimary=false`; never encode lifecycle in the platform role.
3
+ * A URL linked to an entity or person, with its status, crawl results, and source. Lifecycle state (current vs former, primary vs secondary) is encoded by `isCurrent` and `isPrimary` — `urlType` names only the platform (website, linkedin, and so on), and its write values come from GET /v1/url-types. Readers accept new platform types as deployments evolve. To record a rebrand or domain migration, retain the prior URL with the same `urlType` (typically `website`) and set `isCurrent=false, isPrimary=false`; never encode lifecycle in the platform type.
4
4
  *
5
5
  * @openapiSchema EntityUrlLink
6
6
  * @endpoint GET /v1/entities/brand
@@ -5,7 +5,7 @@ import { EntityUrlCrawlCdnProviderSchema } from "./url-crawl-cdn-provider.js";
5
5
  import { EntityUrlCrawlRenderModeSchema } from "./url-crawl-render-mode.js";
6
6
  import { EntityUrlTypeSchema } from "./url-type.js";
7
7
  /**
8
- * Canonical URL link resource with owner, status, crawl, and source metadata. Lifecycle state (current vs former, primary vs secondary) is encoded by `isCurrent` and `isPrimary` — `urlType` is the canonical platform role only and write values come from GET /v1/url-types. Readers accept new platform roles as deployments evolve. To record a rebrand or domain migration, retain the prior URL with the same `urlType` (typically `website`) and set `isCurrent=false, isPrimary=false`; never encode lifecycle in the platform role.
8
+ * A URL linked to an entity or person, with its status, crawl results, and source. Lifecycle state (current vs former, primary vs secondary) is encoded by `isCurrent` and `isPrimary` — `urlType` names only the platform (website, linkedin, and so on), and its write values come from GET /v1/url-types. Readers accept new platform types as deployments evolve. To record a rebrand or domain migration, retain the prior URL with the same `urlType` (typically `website`) and set `isCurrent=false, isPrimary=false`; never encode lifecycle in the platform type.
9
9
  *
10
10
  * @openapiSchema EntityUrlLink
11
11
  * @endpoint GET /v1/entities/brand
@@ -68,7 +68,7 @@ export const EntityUrlLinkSchema = z.object({
68
68
  /** Time of the latest URL status observation. */
69
69
  statusChecked: z.iso.datetime({ offset: true }).nullish(),
70
70
  updatedAt: z.iso.datetime({ offset: true }).nullish(),
71
- /** Canonical absolute URL after storage and live same-site host normalization. */
71
+ /** Absolute URL as stored, with the host normalized to the form the live site uses. */
72
72
  url: z.string(),
73
73
  urlType: EntityUrlTypeSchema,
74
74
  });
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Which canonical store the point came from.
3
+ * Where the point came from: a research detail or a funding round.
4
4
  *
5
5
  * @openapiSchema EntityValuationSource
6
6
  * @endpoint GET /v1/entities/lookup-exact
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Which canonical store the point came from.
4
+ * Where the point came from: a research detail or a funding round.
5
5
  *
6
6
  * @openapiSchema EntityValuationSource
7
7
  * @endpoint GET /v1/entities/lookup-exact
@@ -15,7 +15,7 @@ const EntityValuationTimeSeriesPointSchemaDefinition = z.object({
15
15
  confidence: EntityValuationDataConfidenceSchema,
16
16
  /** ISO 4217 currency code. */
17
17
  currency: z.string(),
18
- /** Exact source monetary decimal string for a research-detail valuation; legacy Long values are only projections. */
18
+ /** Valuation of a research detail exactly as the source states it, as a decimal string; the older whole-number value is only an approximation of it. */
19
19
  decimalValue: z.string().nullish(),
20
20
  /** Basis declared by the original source. */
21
21
  declaredBasis: ValuationTypeSchema,
@@ -29,7 +29,7 @@ const EntityValuationTimeSeriesPointSchemaDefinition = z.object({
29
29
  measurementBasis: z.string().nullish(),
30
30
  /** Source-stated reporting scope. */
31
31
  reportingScope: z.string().nullish(),
32
- /** Canonical store that supplied the point. */
32
+ /** Where the point came from: a research detail or a funding round. */
33
33
  source: EntityValuationSourceSchema,
34
34
  /** `detail-<id>` or `fundraise-<transactionId>` display reference. */
35
35
  sourceRef: z.string(),
@@ -5,13 +5,13 @@ import { SearchModeExecutionSchema } from "../search/mode-execution.js";
5
5
  const FederatedSearchProvenanceSchemaDefinition = z.object({
6
6
  /** True when synthesis was requested but the answer model was temporarily unavailable (an upstream outage, open circuit, full concurrency limit, or expired deadline), so the entity scope carries no answer while every scope's rows returned, or when the answer check refused every paragraph the answer model drafted, so the answer has no paragraph. Retrying the same query may succeed. */
7
7
  answerUnavailable: z.boolean(),
8
- /** Entity search strategy execution. */
8
+ /** Search method requested and used for entities. */
9
9
  entity: SearchModeExecutionSchema,
10
10
  /** Scopes whose required named subjects could not be resolved, or whose optional sources or candidate judgments did not all complete. Returned rows remain usable but the requested population is incomplete, so this response must not be cached as final. Clarifying the named subjects or retrying may complete these scopes. */
11
11
  incompleteScope: z.array(z.enum(["entity", "person", "news"])).optional(),
12
- /** News search strategy execution. */
12
+ /** Search method requested and used for news. */
13
13
  news: SearchModeExecutionSchema,
14
- /** Person search strategy execution. */
14
+ /** Search method requested and used for people. */
15
15
  person: SearchModeExecutionSchema,
16
16
  /** Scopes that rejected the query as unsearchable and returned an empty page while the other scopes ran; empty when every scope ran. */
17
17
  rejection: z.array(FederatedSearchRejectionSchema),
@@ -14379,7 +14379,7 @@ type FederatedSearchDefinition = z.infer<typeof FederatedSearchSchemaDefinition>
14379
14379
  export interface FederatedSearchSchemaInput extends z.input<typeof FederatedSearchSchemaDefinition> {
14380
14380
  }
14381
14381
  /**
14382
- * Federated entity, person, and news search result composed from each domain's canonical search result owner, with the strategy used for every scope.
14382
+ * Combined entity, person, and news search results, each from that record type's own search, with the search method used for each.
14383
14383
  *
14384
14384
  * @openapiSchema FederatedSearch
14385
14385
  * @endpoint GET /v1/search/link
@@ -13,7 +13,7 @@ const FederatedSearchSchemaDefinition = z.object({
13
13
  entity: NaturalSearchResultSchema,
14
14
  /** Public detail for Product/Service rows on the entity result page, in search rank order. Other entity types are not hydrated. */
15
15
  entityDetail: z.array(EntityDetailSchema),
16
- /** Canonical news page returned by the keyword list engine. */
16
+ /** Page of news results from keyword search. */
17
17
  news: PageResultNewsSchema,
18
18
  /** Public entities each news row on the page links to, in news page order; a row with no public entity link has no entry. */
19
19
  newsEntityMention: z.array(NewsEntityMentionSchema),
@@ -31,7 +31,7 @@ const FederatedSearchSchemaDefinition = z.object({
31
31
  section: z.array(z.enum(["person", "company", "productService", "investor"])).optional(),
32
32
  });
33
33
  /**
34
- * Federated entity, person, and news search result composed from each domain's canonical search result owner, with the strategy used for every scope.
34
+ * Combined entity, person, and news search results, each from that record type's own search, with the search method used for each.
35
35
  *
36
36
  * @openapiSchema FederatedSearch
37
37
  * @endpoint GET /v1/search/link
@@ -407,7 +407,7 @@ type FundraiseInvestmentEvidenceDefinition = z.infer<typeof FundraiseInvestmentE
407
407
  export interface FundraiseInvestmentEvidenceSchemaInput extends z.input<typeof FundraiseInvestmentEvidenceSchemaDefinition> {
408
408
  }
409
409
  /**
410
- * Canonical transaction, participation attribution, and their owning source metadata.
410
+ * A funding round, the investor's part in it, and the sources for each.
411
411
  *
412
412
  * @openapiSchema FundraiseInvestmentEvidence
413
413
  * @endpoint GET /v1/search/link
@@ -13,7 +13,7 @@ const FundraiseInvestmentEvidenceSchemaDefinition = z.object({
13
13
  investorJoinSource: DatasourceSourceMetadataSchema.nullish(),
14
14
  });
15
15
  /**
16
- * Canonical transaction, participation attribution, and their owning source metadata.
16
+ * A funding round, the investor's part in it, and the sources for each.
17
17
  *
18
18
  * @openapiSchema FundraiseInvestmentEvidence
19
19
  * @endpoint GET /v1/search/link
@@ -4,7 +4,7 @@ const GithubRepoSchemaDefinition = z.object({
4
4
  createdAt: z.iso.datetime({ offset: true }).nullish(),
5
5
  description: z.string().nullish(),
6
6
  forkCount: z.int(),
7
- /** GitHub's stable numeric repository id; sync upsert key per owner */
7
+ /** GitHub's stable numeric repository id; each sync uses it to match and update the owner's repository record */
8
8
  githubId: z.number().int(),
9
9
  /** Project homepage URL declared on the repository */
10
10
  homepageUrl: z.string().nullish(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Agent loop a harness run executes on: the Claude Agent SDK or the Pi agent SDK
3
+ * Agent framework a research run executes on: the Claude Agent SDK or the Pi agent SDK
4
4
  *
5
5
  * @openapiSchema HarnessChassis
6
6
  * @endpoint GET /v1/research/runs
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Agent loop a harness run executes on: the Claude Agent SDK or the Pi agent SDK
4
+ * Agent framework a research run executes on: the Claude Agent SDK or the Pi agent SDK
5
5
  *
6
6
  * @openapiSchema HarnessChassis
7
7
  * @endpoint GET /v1/research/runs
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Gateway wire API for a run's LLM calls: Anthropic Messages, OpenAI Chat Completions, or OpenAI Responses
3
+ * Language-model API format a run's calls use: Anthropic Messages, OpenAI Chat Completions, or OpenAI Responses
4
4
  *
5
5
  * @openapiSchema HarnessLlmApi
6
6
  * @endpoint GET /v1/research/runs
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Gateway wire API for a run's LLM calls: Anthropic Messages, OpenAI Chat Completions, or OpenAI Responses
4
+ * Language-model API format a run's calls use: Anthropic Messages, OpenAI Chat Completions, or OpenAI Responses
5
5
  *
6
6
  * @openapiSchema HarnessLlmApi
7
7
  * @endpoint GET /v1/research/runs
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Unsuccessful direct-session research disposition
3
+ * How unsuccessful research ended: PARTIAL (some of it finished) or BLOCKED
4
4
  *
5
5
  * @openapiSchema HarnessResearchOutcome
6
6
  * @endpoint GET /v1/research/runs
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  const HarnessResearchOutcomeSchemaKnownMembers = z.enum(["PARTIAL", "BLOCKED"]);
4
4
  /**
5
- * Unsuccessful direct-session research disposition
5
+ * How unsuccessful research ended: PARTIAL (some of it finished) or BLOCKED
6
6
  *
7
7
  * @openapiSchema HarnessResearchOutcome
8
8
  * @endpoint GET /v1/research/runs
@@ -7,7 +7,7 @@ import { HarnessRunSchema } from "./run.js";
7
7
  const HarnessRunDetailSchemaDefinition = z.object({
8
8
  /** Current public profile the run resolved to */
9
9
  entity: EntitySchema.nullish(),
10
- /** Follow-up admission and direct child run ids for this terminal generation */
10
+ /** Follow-up runs filed when this run last finished, and their ids */
11
11
  followUp: HarnessRunFollowUpSchema.optional(),
12
12
  /** Time the run's newest stream event was recorded; null when the run has no events. A running run whose value stops advancing has stalled */
13
13
  lastEventAt: z.iso.datetime({ offset: true }).nullish(),
@@ -5,7 +5,7 @@ const HarnessRunEventSchemaDefinition = z.object({
5
5
  createdAt: z.iso.datetime({ offset: true }),
6
6
  /** Monotonic event id */
7
7
  id: z.number().int(),
8
- /** Run-stream envelope as an opaque JSON string */
8
+ /** The full stream event as a JSON string */
9
9
  payload: z.string(),
10
10
  /** Owning run id */
11
11
  runId: z.uuid(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Durable admission state for one terminal run generation's follow-up work
3
+ * Whether the follow-up runs requested when this run last finished have all been filed
4
4
  *
5
5
  * @openapiSchema HarnessRunFollowUpAdmission
6
6
  * @endpoint GET /v1/research/runs
@@ -1,7 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Durable admission state for one terminal run generation's follow-up work
4
+ * Whether the follow-up runs requested when this run last finished have all been filed
5
5
  *
6
6
  * @openapiSchema HarnessRunFollowUpAdmission
7
7
  * @endpoint GET /v1/research/runs
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Durable completion barrier and direct child run ids
3
+ * Follow-up runs this run started, and whether all of them have been filed
4
4
  *
5
5
  * @openapiSchema HarnessRunFollowUp
6
6
  * @endpoint GET /v1/research/runs/{runId}
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { HarnessRunFollowUpAdmissionSchema } from "./run-follow-up-admission.js";
4
4
  /**
5
- * Durable completion barrier and direct child run ids
5
+ * Follow-up runs this run started, and whether all of them have been filed
6
6
  *
7
7
  * @openapiSchema HarnessRunFollowUp
8
8
  * @endpoint GET /v1/research/runs/{runId}
@@ -11,11 +11,11 @@ import { HarnessRunFollowUpAdmissionSchema } from "./run-follow-up-admission.js"
11
11
  * @contractRole canonical
12
12
  */
13
13
  export const HarnessRunFollowUpSchema = z.object({
14
- /** PENDING until every follow-up admission is durable; REJECTED when the bounded redo is exhausted */
14
+ /** PENDING until every follow-up run has been filed; REJECTED when the allowed redo attempts are used up */
15
15
  admission: HarnessRunFollowUpAdmissionSchema,
16
- /** More than the bounded child count exists; completion is unproven */
16
+ /** True when this run started more follow-up runs than this list shows, so the list cannot prove the run is complete */
17
17
  hasMore: z.boolean(),
18
- /** Direct appointed run ids; read each run's detail recursively */
18
+ /** Ids of follow-up runs this run started directly; read each one's detail to find its own follow-ups */
19
19
  runId: z.array(z.uuid()),
20
20
  });
21
21
  //# sourceMappingURL=run-follow-up.js.map
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Queue lane for admission priority: live (search and lookup) and interactive (one client run) take interactive admission; bulk (client batch) and background (system backlog) take background admission
3
+ * Queue priority of a run: live (search and lookup) and interactive (one client run) share the interactive queue; bulk (client batch) and background (system backlog) share the background queue
4
4
  *
5
5
  * @openapiSchema HarnessRunLane
6
6
  * @endpoint GET /v1/research/runs
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  const HarnessRunLaneSchemaKnownMembers = z.enum(["live", "interactive", "bulk", "background"]);
4
4
  /**
5
- * Queue lane for admission priority: live (search and lookup) and interactive (one client run) take interactive admission; bulk (client batch) and background (system backlog) take background admission
5
+ * Queue priority of a run: live (search and lookup) and interactive (one client run) share the interactive queue; bulk (client batch) and background (system backlog) share the background queue
6
6
  *
7
7
  * @openapiSchema HarnessRunLane
8
8
  * @endpoint GET /v1/research/runs
@@ -12,7 +12,7 @@ import { z } from "zod/v4";
12
12
  export const HarnessRunProgressSchema = z.object({
13
13
  /** Whether the enrichment loop reports completion */
14
14
  complete: z.boolean(),
15
- /** Canonical entity slug currently reported by the loop */
15
+ /** Slug of the entity the run is researching, as last reported */
16
16
  entitySlug: z
17
17
  .string()
18
18
  .regex(/^[a-z0-9_-]+$/)
@@ -30,9 +30,9 @@ import { ResearchAllowanceTypeSchema } from "../research/allowance-type.js";
30
30
  export const HarnessRunSchema = z.object({
31
31
  /** Retry attempt counter */
32
32
  attempt: z.int(),
33
- /** Agent loop this run executes on */
33
+ /** Agent framework this run executes on */
34
34
  chassis: HarnessChassisSchema.nullish(),
35
- /** True when the chassis router, not a caller, picked `chassis` */
35
+ /** True when aVenture, not the caller, chose `chassis` */
36
36
  chassisRouted: z.boolean(),
37
37
  /** Creation timestamp */
38
38
  createdAt: z.iso.datetime({ offset: true }),
@@ -48,9 +48,9 @@ export const HarnessRunSchema = z.object({
48
48
  failureClass: z.string().nullish(),
49
49
  /** Run completion timestamp */
50
50
  finishedAt: z.iso.datetime({ offset: true }).nullish(),
51
- /** Successful claim acknowledgement only: true on first-ever start, false on reclaim; reads null (unknown) */
51
+ /** Set only in the response that starts the run: true the first time it starts, false when a worker restarts it; null in every other response */
52
52
  firstStart: z.boolean().nullish(),
53
- /** Follow-up admission for the exact current terminal generation; old engine terminals remain PENDING */
53
+ /** Whether follow-up runs from this run's latest finish have all been filed; runs finished by older engine versions stay PENDING */
54
54
  followUpAdmission: HarnessRunFollowUpAdmissionSchema.optional(),
55
55
  /** Whether this run consumes an immutable private source document */
56
56
  hasSourceDocument: z.boolean(),
@@ -60,13 +60,13 @@ export const HarnessRunSchema = z.object({
60
60
  iteration: z.int(),
61
61
  /** Admission class (interactive or background) on client-facing responses; Prefer: run-lane-origin returns the actual queue lane. Engine lifecycle responses always return the actual lane. */
62
62
  lane: HarnessRunLaneSchema,
63
- /** Latest enrich-loop status as an opaque JSON string */
63
+ /** Latest research-loop progress as a free-form JSON string */
64
64
  latestStatus: z.string().nullish(),
65
- /** Gateway wire API every LLM call of this run uses */
65
+ /** Language-model API format this run's calls use */
66
66
  llmApi: HarnessLlmApiSchema.nullish(),
67
67
  /** Loop iteration cap */
68
68
  maxIteration: z.int(),
69
- /** Parallel read-only scout fan-out width N */
69
+ /** How many read-only research helpers the run may use at once */
70
70
  maxScoutConcurrent: z.int(),
71
71
  /** Enrichment breadth selected for this run */
72
72
  mode: EnrichmentModeSchema,
@@ -78,7 +78,7 @@ export const HarnessRunSchema = z.object({
78
78
  nextAttemptAt: z.iso.datetime({ offset: true }).nullish(),
79
79
  /** Research allowance this run reserved when it was filed: COMPANY or PERSON; null for a run filed without one */
80
80
  researchAllowanceType: ResearchAllowanceTypeSchema.nullish(),
81
- /** Partial or blocked direct research, derived from its recorded failure class; null for other outcomes */
81
+ /** How unsuccessful research ended: PARTIAL or BLOCKED, from its recorded failure class; null for other outcomes */
82
82
  researchOutcome: HarnessResearchOutcomeSchema.nullish(),
83
83
  /** Instant past which a warm resume is no longer guaranteed; the harness writes it with session_resume from the model's cache window. Warm-resumable now iff failed/stopped and this is in the future. Null when there is no resume window. */
84
84
  resumeSafeUntil: z.iso.datetime({ offset: true }).nullish(),
@@ -86,7 +86,7 @@ export const HarnessRunSchema = z.object({
86
86
  startedAt: z.iso.datetime({ offset: true }).nullish(),
87
87
  /** Current lifecycle state */
88
88
  status: HarnessRunStatusSchema,
89
- /** Read-only research, cohort, and completion sub-agent model id */
89
+ /** Model id of the run's read-only research and check helpers */
90
90
  subagentModel: z.string().nullish(),
91
91
  /** True when the requester left `subagentModel` to the auto router, which picks it again each time the run leaves the queue; null on engine lease responses */
92
92
  subagentModelRouted: z.boolean().nullish(),
@@ -4,7 +4,7 @@ import { EntityWriterBriefSchema } from "../entity/writer-brief.js";
4
4
  import { HarnessTaskFactSchema } from "./task-fact.js";
5
5
  import { WriterBriefSchema } from "../writer/brief.js";
6
6
  const HarnessTaskInputBindingSchemaDefinition = z.object({
7
- /** Canonical entity UUID; exclusive with newsId, text, writerBrief and fact. */
7
+ /** Entity id (UUID); exclusive with newsId, text, writerBrief and fact. */
8
8
  entityId: z.uuid().nullish(),
9
9
  /** Section-free entity or person text brief for a WRITER_BRIEF input; exclusive with writerBrief, entityId, newsId, text and fact. The task must create entity or person text. Use this typed value only with compatible Harness readers; legacy writerBrief remains supported. */
10
10
  entityWriterBrief: EntityWriterBriefSchema.nullish(),
@@ -12,7 +12,7 @@ const HarnessTaskInputBindingSchemaDefinition = z.object({
12
12
  fact: HarnessTaskFactSchema.nullish(),
13
13
  /** Catalog input key; omit it to bind the task's only declared input of the value's type. */
14
14
  key: z.string().nullish(),
15
- /** Canonical news id; exclusive with entityId, text, writerBrief and fact. */
15
+ /** aVenture news id; exclusive with entityId, text, writerBrief and fact. */
16
16
  newsId: z.int().nullish(),
17
17
  /** Literal requester text; exclusive with entityId, newsId, writerBrief and fact. */
18
18
  text: z.string().nullish(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * NEWS binds a public article to its canonical news id; ENTITY binds a target entity to its canonical id through entity identification; TEXT is a literal value the request states; FACT is one source-bound claim to research; WRITER_BRIEF is the typed research analysis a prose writer composes from (claim ledger, positioning frame, paragraph plan).
3
+ * NEWS is a public article, given by its aVenture news id; ENTITY is a target entity, identified and given by its aVenture id; TEXT is a literal value the request states; FACT is one source-bound claim to research; WRITER_BRIEF is the typed research analysis a prose writer composes from (claim ledger, positioning frame, paragraph plan).
4
4
  *
5
5
  * @openapiSchema HarnessTaskInputType
6
6
  * @endpoint POST /v1/help
@@ -8,7 +8,7 @@ const HarnessTaskInputTypeSchemaKnownMembers = z.enum([
8
8
  "WRITER_BRIEF",
9
9
  ]);
10
10
  /**
11
- * NEWS binds a public article to its canonical news id; ENTITY binds a target entity to its canonical id through entity identification; TEXT is a literal value the request states; FACT is one source-bound claim to research; WRITER_BRIEF is the typed research analysis a prose writer composes from (claim ledger, positioning frame, paragraph plan).
11
+ * NEWS is a public article, given by its aVenture news id; ENTITY is a target entity, identified and given by its aVenture id; TEXT is a literal value the request states; FACT is one source-bound claim to research; WRITER_BRIEF is the typed research analysis a prose writer composes from (claim ledger, positioning frame, paragraph plan).
12
12
  *
13
13
  * @openapiSchema HarnessTaskInputType
14
14
  * @endpoint POST /v1/help
@@ -14,7 +14,7 @@ import { HarnessTaskSchema } from "./task.js";
14
14
  export const HarnessTaskPlanSchema = z.object({
15
15
  /** Stored catalog revision this plan was read from. */
16
16
  catalogRevision: z.int().optional(),
17
- /** Canonical completion gate ids this task is responsible for; the ids resolve through the completion contract catalog. */
17
+ /** Ids of the completion checks this task must pass, as listed in the completion check catalog. */
18
18
  gateId: z.array(z.string()).optional(),
19
19
  /** Typed task inputs; required inputs must be bound before it runs. */
20
20
  input: z.array(HarnessTaskSchema),
@@ -20,7 +20,7 @@ export const HarnessTaskWriteGuidanceSchema = z.object({
20
20
  override: z.string(),
21
21
  /** Each problem that rejects this prose: what fails it and the fix. */
22
22
  reject: z.array(z.string()),
23
- /** The read that serves this write's per-type hints; read it before writing. */
23
+ /** The read operation that returns per-type hints for this write; call it first. */
24
24
  typeCatalog: z.string(),
25
25
  });
26
26
  //# sourceMappingURL=task-write-guidance.js.map
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Corpus partition a help citation is drawn from.
3
+ * Which part of the help material a citation comes from.
4
4
  *
5
5
  * @openapiSchema HelpSourceType
6
6
  * @endpoint POST /v1/help
@@ -10,7 +10,7 @@ const HelpSourceTypeSchemaKnownMembers = z.enum([
10
10
  "TEXT_TYPE",
11
11
  ]);
12
12
  /**
13
- * Corpus partition a help citation is drawn from.
13
+ * Which part of the help material a citation comes from.
14
14
  *
15
15
  * @openapiSchema HelpSourceType
16
16
  * @endpoint POST /v1/help
@@ -19,7 +19,7 @@ import { ResearchAllowanceTypeSchema } from "../research/allowance-type.js";
19
19
  export const ProblemDetailSchema = z.object({
20
20
  /** Which monthly allowance a BILLING_ALLOWANCE refusal exhausted. */
21
21
  allowanceType: ResearchAllowanceTypeSchema.nullish(),
22
- /** The unmet own-site proof for an NCES campus lookup; absent for other failures. */
22
+ /** For a school campus lookup (NCES records), the evidence from the campus's own website that is still missing; absent for other failures. */
23
23
  campusProofRefusal: IdentificationCampusRefusalSchema.nullish(),
24
24
  circuitBreaker: z.string().nullish(),
25
25
  /** Machine-readable secondary code on ProblemDetail.code. Agents should branch on this value when the HTTP status alone does not identify the recovery path. Many codes describe server-side conditions a caller cannot fix: surface them and stop. */
@@ -286,7 +286,7 @@ export const ProblemDetailSchema = z.object({
286
286
  traceId: z.string().nullish(),
287
287
  type: z.string().optional(),
288
288
  unknownParameters: z.array(z.string()).nullish(),
289
- /** On a task-completion 409, the completion gate ids whose owning reads did not pass; absent for every other problem. */
289
+ /** On a task-completion 409, the ids of the completion checks that failed; absent for every other problem. */
290
290
  unmetGateId: z.array(z.string()).nullish(),
291
291
  /** Requests already charged against the limitType meter this period. */
292
292
  used: z.number().int().nullish(),
@@ -20,9 +20,9 @@ export const IdentificationCandidateSchema = z.object({
20
20
  dataCompletionCoverage: z.int().min(0).max(100).nullish(),
21
21
  /** Whether this record's stored website agrees with a url the subject supplied; see IdentificationDomainAgreement. */
22
22
  domainAgreement: z.enum(["MATCH", "CONFLICT", "UNKNOWN"]).nullish(),
23
- /** How this record was checked as the picked record stored again; absent when it was not checked. */
23
+ /** How this record was checked for being a duplicate of the chosen record; absent when it was not checked. */
24
24
  duplicateBasis: z.enum(["STUB", "SHARED_FACT", "JUDGED"]).nullish(),
25
- /** Probability, 0 to 1, that this record is the picked record stored again; present only when duplicateBasis is JUDGED. */
25
+ /** Probability, 0 to 1, that this record is a duplicate of the chosen record; present only when duplicateBasis is JUDGED. */
26
26
  duplicateProbability: z.number().nullish(),
27
27
  /** The year the entity was founded, when stored; absent for people and records without one. */
28
28
  foundedYear: z.int().nullish(),
@@ -44,9 +44,9 @@ export const IdentificationSchema = z.object({
44
44
  match: IdentificationCandidateSchema.nullish(),
45
45
  /** The subject's own website or profile page found in web search, or a supplied LinkedIn person profile verified against the subject's name and employer for a deterministic match. It may be a profile page on another site rather than the subject's own domain. Only the verified supplied profile may be attached to an existing person matched by name and employer. */
46
46
  officialUrl: z.string().nullish(),
47
- /** Use the scoped match, record scoped absence, or refine an ambiguous identity with evidence. */
47
+ /** What to do next: use the match, record that no match exists in this scope, or add evidence to settle an ambiguous identity. */
48
48
  status: z.enum(["MATCHED", "NO_MATCH", "NEEDS_REVIEW"]),
49
- /** Fresh backend URL evidence gathered when verifyUrl=true; empty otherwise. */
49
+ /** Results of live URL checks the server ran because verifyUrl=true; empty otherwise. */
50
50
  urlHostForm: z.array(UrlHostFormResolutionSchema),
51
51
  });
52
52
  //# sourceMappingURL=identification.js.map
@@ -197,7 +197,7 @@ type InvestorPortfolioRecipientDefinition = z.infer<typeof InvestorPortfolioReci
197
197
  export interface InvestorPortfolioRecipientSchemaInput extends z.input<typeof InvestorPortfolioRecipientSchemaDefinition> {
198
198
  }
199
199
  /**
200
- * Recipient identity with canonical recorded funding coverage.
200
+ * A portfolio recipient and the funding aVenture has recorded for it.
201
201
  *
202
202
  * @openapiSchema InvestorPortfolioRecipient
203
203
  * @endpoint GET /v1/entities/lookup-exact