@aventurevc/api-schemas 0.8.375 → 0.8.377

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 (206) 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.d.ts +1 -1
  81. package/dist/entity/sitemap.js +6 -6
  82. package/dist/entity/tag.js +1 -1
  83. package/dist/entity/text.d.ts +1 -1
  84. package/dist/entity/text.js +4 -4
  85. package/dist/entity/type-alias.d.ts +1 -1
  86. package/dist/entity/type-alias.js +2 -2
  87. package/dist/entity/type-group-membership.d.ts +1 -1
  88. package/dist/entity/type-group-membership.js +1 -1
  89. package/dist/entity/type-group.d.ts +1 -1
  90. package/dist/entity/type-group.js +1 -1
  91. package/dist/entity/type.d.ts +1 -1
  92. package/dist/entity/type.js +1 -1
  93. package/dist/entity/url-link.d.ts +1 -1
  94. package/dist/entity/url-link.js +2 -2
  95. package/dist/entity/valuation-source.d.ts +1 -1
  96. package/dist/entity/valuation-source.js +1 -1
  97. package/dist/entity/valuation-time-series-point.js +2 -2
  98. package/dist/federated/search-provenance.js +3 -3
  99. package/dist/federated/search.d.ts +1 -1
  100. package/dist/federated/search.js +2 -2
  101. package/dist/fundraise/investment-evidence.d.ts +1 -1
  102. package/dist/fundraise/investment-evidence.js +1 -1
  103. package/dist/github/repo.js +1 -1
  104. package/dist/harness/chassis.d.ts +1 -1
  105. package/dist/harness/chassis.js +1 -1
  106. package/dist/harness/llm-api.d.ts +1 -1
  107. package/dist/harness/llm-api.js +1 -1
  108. package/dist/harness/research-outcome.d.ts +1 -1
  109. package/dist/harness/research-outcome.js +1 -1
  110. package/dist/harness/run-detail.js +1 -1
  111. package/dist/harness/run-event.js +1 -1
  112. package/dist/harness/run-follow-up-admission.d.ts +1 -1
  113. package/dist/harness/run-follow-up-admission.js +1 -1
  114. package/dist/harness/run-follow-up.d.ts +1 -1
  115. package/dist/harness/run-follow-up.js +4 -4
  116. package/dist/harness/run-lane.d.ts +1 -1
  117. package/dist/harness/run-lane.js +1 -1
  118. package/dist/harness/run-progress.js +1 -1
  119. package/dist/harness/run.js +9 -9
  120. package/dist/harness/task-input-binding.js +2 -2
  121. package/dist/harness/task-input-type.d.ts +1 -1
  122. package/dist/harness/task-input-type.js +1 -1
  123. package/dist/harness/task-plan.js +1 -1
  124. package/dist/harness/task-write-guidance.js +1 -1
  125. package/dist/help/source-type.d.ts +1 -1
  126. package/dist/help/source-type.js +1 -1
  127. package/dist/http/problem-detail.js +2 -2
  128. package/dist/identification/candidate.js +2 -2
  129. package/dist/identification/identification.js +2 -2
  130. package/dist/investor/portfolio-recipient.d.ts +1 -1
  131. package/dist/investor/portfolio-recipient.js +1 -1
  132. package/dist/lookup/job.js +2 -2
  133. package/dist/lookup/source-read.d.ts +1 -1
  134. package/dist/lookup/source-read.js +2 -2
  135. package/dist/natural/search-result.d.ts +1 -1
  136. package/dist/natural/search-result.js +3 -3
  137. package/dist/natural/search.d.ts +1 -1
  138. package/dist/natural/search.js +1 -1
  139. package/dist/news/analysis.js +1 -1
  140. package/dist/news/detail.d.ts +1 -1
  141. package/dist/news/detail.js +1 -1
  142. package/dist/news/news.d.ts +1 -1
  143. package/dist/news/news.js +3 -3
  144. package/dist/news/resolved-entity-link.js +2 -2
  145. package/dist/news/resolved-person-link.js +2 -2
  146. package/dist/news/source-url-conflict.js +1 -1
  147. package/dist/person/detail.d.ts +1 -1
  148. package/dist/person/detail.js +1 -1
  149. package/dist/person/filter.d.ts +1 -1
  150. package/dist/person/filter.js +1 -1
  151. package/dist/person/graph-career-context.js +2 -2
  152. package/dist/person/graph-co-investor.js +2 -2
  153. package/dist/person/graph-member.d.ts +1 -1
  154. package/dist/person/graph-member.js +4 -4
  155. package/dist/person/graph-similar-entity.js +1 -1
  156. package/dist/person/graph.d.ts +1 -1
  157. package/dist/person/graph.js +1 -1
  158. package/dist/person/image.d.ts +1 -1
  159. package/dist/person/image.js +1 -1
  160. package/dist/person/investment.d.ts +1 -1
  161. package/dist/person/investment.js +2 -2
  162. package/dist/person/lookup-exact-param.js +4 -4
  163. package/dist/person/natural-search-result.d.ts +1 -1
  164. package/dist/person/natural-search-result.js +2 -2
  165. package/dist/person/natural-search.js +1 -1
  166. package/dist/person/person.d.ts +1 -1
  167. package/dist/person/person.js +5 -5
  168. package/dist/redirect/current-slug-owner.d.ts +1 -1
  169. package/dist/redirect/current-slug-owner.js +1 -1
  170. package/dist/research/allowance-usage.js +1 -1
  171. package/dist/research/derived-range.d.ts +1 -1
  172. package/dist/research/derived-range.js +1 -1
  173. package/dist/research/detail-type.js +1 -1
  174. package/dist/research/paragraph-shape.d.ts +1 -1
  175. package/dist/research/paragraph-shape.js +1 -1
  176. package/dist/research/snippet-type.d.ts +1 -1
  177. package/dist/research/snippet-type.js +3 -3
  178. package/dist/search/cache-mode.d.ts +1 -1
  179. package/dist/search/cache-mode.js +1 -1
  180. package/dist/search/investment.d.ts +1 -1
  181. package/dist/search/investment.js +1 -1
  182. package/dist/search/mode-execution.d.ts +1 -1
  183. package/dist/search/mode-execution.js +2 -2
  184. package/dist/sec/company.js +1 -1
  185. package/dist/shared/directory-list.js +1 -1
  186. package/dist/shared/search-list.js +1 -1
  187. package/dist/source/document-list.d.ts +1 -1
  188. package/dist/source/document-list.js +3 -3
  189. package/dist/stage/frequency.d.ts +1 -1
  190. package/dist/stage/frequency.js +1 -1
  191. package/dist/standardized/classification-filter.js +1 -1
  192. package/dist/text/type-option.d.ts +1 -1
  193. package/dist/text/type-option.js +5 -5
  194. package/dist/unique/id-mutation.js +1 -1
  195. package/dist/unique/id-type-alias.d.ts +1 -1
  196. package/dist/unique/id-type-alias.js +3 -3
  197. package/dist/unique/id.js +1 -1
  198. package/dist/url/duplicate-conflict.js +2 -2
  199. package/dist/url/duplicate-join.d.ts +1 -1
  200. package/dist/url/duplicate-join.js +1 -1
  201. package/dist/url/type-alias.d.ts +1 -1
  202. package/dist/url/type-alias.js +2 -2
  203. package/dist/web/search.js +1 -1
  204. package/dist/writer/claim-surface.d.ts +1 -1
  205. package/dist/writer/claim-surface.js +1 -1
  206. package/package.json +1 -1
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Canonical address record for entity and person payloads
3
+ * A postal address of an entity or person.
4
4
  *
5
5
  * @openapiSchema Address
6
6
  * @endpoint GET /v1/entities/lookup-exact
@@ -5,7 +5,7 @@ import { AddressCitySchema } from "./city.js";
5
5
  import { AddressCountrySchema } from "./country.js";
6
6
  import { AddressStateSchema } from "./state.js";
7
7
  /**
8
- * Canonical address record for entity and person payloads
8
+ * A postal address of an entity or person.
9
9
  *
10
10
  * @openapiSchema Address
11
11
  * @endpoint GET /v1/entities/lookup-exact
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { AgentTaskPresetSchema } from "./task-preset.js";
4
4
  const AgentTaskPresetCatalogSchemaDefinition = z.object({
5
- /** Available task presets. Field name is singular by repository convention even though the value is a collection. */
5
+ /** Available task presets. The field name is singular, but it holds a list. */
6
6
  taskPreset: z.array(AgentTaskPresetSchema),
7
7
  });
8
8
  /**
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Dispatch phase governing intra-job ordering when presets are multi-selected.
3
+ * Run order when several presets are selected: PRIMARY presets run first; FINAL presets run after them, together, so they read the updated profile.
4
4
  *
5
5
  * @openapiSchema AgentTaskPresetPhase
6
6
  * @endpoint GET /v1/research/runs/presets
@@ -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
- * Dispatch phase governing intra-job ordering when presets are multi-selected.
4
+ * Run order when several presets are selected: PRIMARY presets run first; FINAL presets run after them, together, so they read the updated profile.
5
5
  *
6
6
  * @openapiSchema AgentTaskPresetPhase
7
7
  * @endpoint GET /v1/research/runs/presets
@@ -9,7 +9,7 @@ const AgentTaskPresetSchemaDefinition = z.object({
9
9
  key: z.string(),
10
10
  /** Display name of the topic the preset researches. */
11
11
  name: z.string(),
12
- /** Dispatch phase for intra-job ordering: PRIMARY presets run first; FINAL presets defer until the primary wave completes so they read the freshly-updated entity dossier. */
12
+ /** Run order within one job: PRIMARY presets run first; FINAL presets wait until every PRIMARY preset finishes so they read the freshly updated entity profile. */
13
13
  phase: AgentTaskPresetPhaseSchema,
14
14
  });
15
15
  /**
@@ -28,7 +28,7 @@ type AuthOperationAuthorizationDefinition = z.infer<typeof AuthOperationAuthoriz
28
28
  export interface AuthOperationAuthorizationSchemaInput extends z.input<typeof AuthOperationAuthorizationSchemaDefinition> {
29
29
  }
30
30
  /**
31
- * Current permission grant, access class, and supplied API operations admitted by the live request authorization policy.
31
+ * Your current permissions, access level, and which of the API operations you listed you may call under the current authorization policy.
32
32
  *
33
33
  * @openapiSchema AuthOperationAuthorization
34
34
  * @endpoint POST /v1/auth/me/permissions
@@ -4,7 +4,7 @@ import { AuthOperationAccessSchema } from "./operation-access.js";
4
4
  import { AuthOperationSchema } from "./operation.js";
5
5
  import { AuthPermissionGrantSchema } from "./permission-grant.js";
6
6
  const AuthOperationAuthorizationSchemaDefinition = z.object({
7
- /** Supplied operations admitted by the current session. */
7
+ /** Operations from your list that the current session may call. */
8
8
  operation: z.array(AuthOperationSchema),
9
9
  /** Highest access class represented by the current session. */
10
10
  operationAccess: AuthOperationAccessSchema,
@@ -12,7 +12,7 @@ const AuthOperationAuthorizationSchemaDefinition = z.object({
12
12
  permissionGrant: AuthPermissionGrantSchema,
13
13
  });
14
14
  /**
15
- * Current permission grant, access class, and supplied API operations admitted by the live request authorization policy.
15
+ * Your current permissions, access level, and which of the API operations you listed you may call under the current authorization policy.
16
16
  *
17
17
  * @openapiSchema AuthOperationAuthorization
18
18
  * @endpoint POST /v1/auth/me/permissions
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * External research-side blog-post source classification
3
+ * Where a collected blog post came from
4
4
  *
5
5
  * @openapiSchema BlogPostType
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
- * External research-side blog-post source classification
4
+ * Where a collected blog post came from
5
5
  *
6
6
  * @openapiSchema BlogPostType
7
7
  * @endpoint GET /v1/entities/lookup-exact
@@ -34,7 +34,7 @@ type BlogPostDefinition = z.infer<typeof BlogPostSchemaDefinition>;
34
34
  export interface BlogPostSchemaInput extends z.input<typeof BlogPostSchemaDefinition> {
35
35
  }
36
36
  /**
37
- * External research-side blog post owned by exactly one entity or person. Unrelated to app.app_blog_article.
37
+ * A blog post published by exactly one entity or person and collected during research. It is not an aVenture blog article.
38
38
  *
39
39
  * @openapiSchema BlogPost
40
40
  * @endpoint GET /v1/entities/lookup-exact
package/dist/blog/post.js CHANGED
@@ -8,7 +8,7 @@ const BlogPostSchemaDefinition = z.object({
8
8
  createdAt: z.iso.datetime({ offset: true }),
9
9
  /** Stable external feed/item identifier when available */
10
10
  externalId: z.string().nullish(),
11
- /** Type-safe UUID identifier for research-side external blog article links */
11
+ /** UUID of a link to an external blog article collected during research */
12
12
  id: z.uuid(),
13
13
  isCurrent: z.boolean(),
14
14
  /** Last time ingest fetched or summarized this blog-post URL */
@@ -32,7 +32,7 @@ const BlogPostSchemaDefinition = z.object({
32
32
  url: z.string(),
33
33
  });
34
34
  /**
35
- * External research-side blog post owned by exactly one entity or person. Unrelated to app.app_blog_article.
35
+ * A blog post published by exactly one entity or person and collected during research. It is not an aVenture blog article.
36
36
  *
37
37
  * @openapiSchema BlogPost
38
38
  * @endpoint GET /v1/entities/lookup-exact
@@ -6,7 +6,7 @@ const ClassificationCatalogBucketSchemaDefinition = z.object({
6
6
  alias: z.array(z.string()),
7
7
  /** Canonical classification bucket key. */
8
8
  bucket: z.string().nullish(),
9
- /** Whether the bucket has hierarchy semantics. */
9
+ /** Whether the bucket's values form a parent and child hierarchy. */
10
10
  hierarchical: z.boolean(),
11
11
  /** Human-readable bucket label (e.g. 'Revenue Model'). */
12
12
  label: z.string(),
@@ -10,7 +10,7 @@ const ClassificationCatalogCategorySchemaDefinition = z.object({
10
10
  classification: z.array(StandardizedClassificationSchema),
11
11
  /** Total standardized classifications in this category. */
12
12
  classificationCount: z.int(),
13
- /** Whether the category has hierarchy semantics. */
13
+ /** Whether the category's values form a parent and child hierarchy. */
14
14
  hierarchical: z.boolean(),
15
15
  /** Human-readable category label. */
16
16
  label: z.string(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Entity classification join registry discriminator for paths where editorial and standardized join row ids may collide.
3
+ * Which kind of entity classification an id belongs to, editorial or standardized; needed on paths where the two kinds can share the same id number.
4
4
  *
5
5
  * @openapiSchema ClassificationJoinRegistry
6
6
  * @endpoint GET /v1/entities/brand
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  const ClassificationJoinRegistrySchemaKnownMembers = z.enum(["editorial", "standardized"]);
4
4
  /**
5
- * Entity classification join registry discriminator for paths where editorial and standardized join row ids may collide.
5
+ * Which kind of entity classification an id belongs to, editorial or standardized; needed on paths where the two kinds can share the same id number.
6
6
  *
7
7
  * @openapiSchema ClassificationJoinRegistry
8
8
  * @endpoint GET /v1/entities/brand
@@ -10,7 +10,7 @@ const CliAuthorizationPollSchemaDefinition = z.object({
10
10
  expiresAt: z.iso.datetime({ offset: true }),
11
11
  /** Current broker lifecycle state */
12
12
  status: CliAuthorizationStatusSchema,
13
- /** Non-secret terminal-state explanation */
13
+ /** Why the request ended (contains no secrets) */
14
14
  terminalReason: CliAuthorizationTerminalReasonSchema.nullish(),
15
15
  });
16
16
  /**
@@ -28,7 +28,7 @@ const CliAuthorizationSchemaDefinition = z.object({
28
28
  status: CliAuthorizationStatusSchema,
29
29
  /** Time this request entered its terminal state */
30
30
  terminalAt: z.iso.datetime({ offset: true }).nullish(),
31
- /** Non-secret terminal-state explanation */
31
+ /** Why the request ended (contains no secrets) */
32
32
  terminalReason: CliAuthorizationTerminalReasonSchema.nullish(),
33
33
  /** Most recent lifecycle update timestamp */
34
34
  updatedAt: z.iso.datetime({ offset: true }),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Derived character/word counts and whether the row text meets its governed type contract (word/character limits and paragraph shape). violation lists each unmet rule and is empty when the row is compliant.
3
+ * Character and word counts for the text, and whether it meets its text type's rules (word and character limits and paragraph shape). violation lists each unmet rule and is empty when the text meets them all.
4
4
  *
5
5
  * @openapiSchema ContentCompliance
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
- * Derived character/word counts and whether the row text meets its governed type contract (word/character limits and paragraph shape). violation lists each unmet rule and is empty when the row is compliant.
4
+ * Character and word counts for the text, and whether it meets its text type's rules (word and character limits and paragraph shape). violation lists each unmet rule and is empty when the text meets them all.
5
5
  *
6
6
  * @openapiSchema ContentCompliance
7
7
  * @endpoint GET /v1/entities/lookup-exact
@@ -30,7 +30,7 @@ import { z } from "zod/v4";
30
30
  export const ContentComplianceSchema = z.object({
31
31
  /** Character count of the row text (UTF-16 units). */
32
32
  characterCount: z.int(),
33
- /** Whether the text satisfies every governed contract rule. */
33
+ /** Whether the text meets every length and paragraph rule for its type. */
34
34
  meetsRequirements: z.boolean(),
35
35
  /** One human-readable reason per unmet rule; empty when compliant. */
36
36
  violation: z.array(z.string()),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Nearest-neighbor content embedding match evidence.
3
+ * Why content matched a meaning-based (semantic) search.
4
4
  *
5
5
  * @openapiSchema ContentEmbeddingMatch
6
6
  * @endpoint GET /v1/entities/lookup-exact
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { ContentSourceTypeSchema } from "./source-type.js";
4
4
  /**
5
- * Nearest-neighbor content embedding match evidence.
5
+ * Why content matched a meaning-based (semantic) search.
6
6
  *
7
7
  * @openapiSchema ContentEmbeddingMatch
8
8
  * @endpoint GET /v1/entities/lookup-exact
@@ -44,13 +44,13 @@ export const ContentEmbeddingMatchSchema = z.object({
44
44
  cosineScore: z.number(),
45
45
  /** Embedding model/profile version for this row. */
46
46
  modelVersion: z.string(),
47
- /** One-based semantic rank within the returned ANN candidate set. */
47
+ /** Rank by meaning similarity among the nearest-neighbor candidates returned, starting at 1. */
48
48
  rank: z.int(),
49
49
  /** SHA-256 hash of the source content. */
50
50
  sourceHash: z.string(),
51
51
  /** Content embedding source identifier. */
52
52
  sourceId: z.string(),
53
- /** Stored content embedding source partition. */
53
+ /** Kind of content that matched. */
54
54
  sourceType: ContentSourceTypeSchema,
55
55
  });
56
56
  //# sourceMappingURL=embedding-match.js.map
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Discriminator for unified content embedding source partitions
3
+ * Kind of content a similarity match came from; new kinds may be added.
4
4
  *
5
5
  * @openapiSchema ContentSourceType
6
6
  * @endpoint GET /v1/entities/lookup-exact
@@ -15,7 +15,7 @@ const ContentSourceTypeSchemaKnownMembers = z.enum([
15
15
  "sourceDocument",
16
16
  ]);
17
17
  /**
18
- * Discriminator for unified content embedding source partitions
18
+ * Kind of content a similarity match came from; new kinds may be added.
19
19
  *
20
20
  * @openapiSchema ContentSourceType
21
21
  * @endpoint GET /v1/entities/lookup-exact
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Grouped source/provenance metadata for private v1 response fields
3
+ * Details of where a record's field values came from.
4
4
  *
5
5
  * @openapiSchema DatasourceSourceMetadata
6
6
  * @endpoint GET /v1/search/link
@@ -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
- * Grouped source/provenance metadata for private v1 response fields
4
+ * Details of where a record's field values came from.
5
5
  *
6
6
  * @openapiSchema DatasourceSourceMetadata
7
7
  * @endpoint GET /v1/search/link
@@ -4,7 +4,7 @@ import { EnrichmentInstructionSchema } from "./instruction.js";
4
4
  import { EnrichmentModeSchema } from "./mode.js";
5
5
  import { HarnessRunLaneSchema } from "../harness/run-lane.js";
6
6
  const EnrichmentBatchSchemaDefinition = z.object({
7
- /** Canonical entity UUIDs to enrich, filed in order before any person */
7
+ /** Entity ids (UUIDs) to enrich, filed in order before any person */
8
8
  entityId: z.array(z.uuid()).optional(),
9
9
  /** Additional instructions for selected records, one entry per owner. Each entry appends to the shared userPrompt for that owner only. Duplicate or unselected owners and combined prompts longer than the run limit are rejected before any run is filed. Omit for identical instructions on every run. */
10
10
  instruction: z.array(EnrichmentInstructionSchema).optional(),
@@ -16,7 +16,7 @@ const EnrichmentBatchSchemaDefinition = z.object({
16
16
  model: z.string().nullish(),
17
17
  /** News article ids. The server identifies every company and person each article names, as POST /v1/lookup/mentions does with sourceNewsId, adds the article's linked companies and people, and files one enrichment per distinct record. */
18
18
  newsId: z.array(z.int()).optional(),
19
- /** Canonical person UUIDs to enrich, filed in order after every entity */
19
+ /** Person ids (UUIDs) to enrich, filed in order after every entity */
20
20
  personId: z.array(z.uuid()).optional(),
21
21
  /** Task preset keys that scope or emphasize every run; at least one is required when mode is INDIVIDUAL, and an unknown key is a 400 */
22
22
  taskPresetKey: z.array(z.string()).nullish(),
@@ -84,7 +84,7 @@ type EntityAcceleratorParticipationDefinition = z.infer<typeof EntityAccelerator
84
84
  export interface EntityAcceleratorParticipationSchemaInput extends z.input<typeof EntityAcceleratorParticipationSchemaDefinition> {
85
85
  }
86
86
  /**
87
- * Flattened accelerator participation derived from acceleratorParticipant relationship rows and joined to the canonical accelerator entity.
87
+ * One accelerator program the entity took part in, from its acceleratorParticipant relationship, with the accelerator's own entity record.
88
88
  *
89
89
  * @openapiSchema EntityAcceleratorParticipation
90
90
  * @endpoint GET /v1/entities/lookup-exact
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { EntitySchema } from "./entity.js";
4
4
  const EntityAcceleratorParticipationSchemaDefinition = z.object({
5
- /** Canonical thin accelerator entity from the acceleratorParticipant relationship */
5
+ /** The accelerator's basic entity record, from the acceleratorParticipant relationship */
6
6
  accelerator: EntitySchema,
7
7
  /** Full accelerator participation name, including program detail */
8
8
  acceleratorName: z.string(),
@@ -12,7 +12,7 @@ const EntityAcceleratorParticipationSchemaDefinition = z.object({
12
12
  .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/),
13
13
  /** Accelerator batch or cohort */
14
14
  batch: z.string().nullish(),
15
- /** Stable participation identifier anchored to the contributing acceleratorParticipant relationship */
15
+ /** Stable id of this participation, tied to the acceleratorParticipant relationship it comes from */
16
16
  id: z.string(),
17
17
  /** Accelerator program name, when the source distinguishes one */
18
18
  program: z.string().nullish(),
@@ -20,7 +20,7 @@ const EntityAcceleratorParticipationSchemaDefinition = z.object({
20
20
  status: z.string().nullish(),
21
21
  });
22
22
  /**
23
- * Flattened accelerator participation derived from acceleratorParticipant relationship rows and joined to the canonical accelerator entity.
23
+ * One accelerator program the entity took part in, from its acceleratorParticipant relationship, with the accelerator's own entity record.
24
24
  *
25
25
  * @openapiSchema EntityAcceleratorParticipation
26
26
  * @endpoint GET /v1/entities/lookup-exact
@@ -7,9 +7,9 @@ import { EntityResearchPublicSourceSchema } from "./research-public-source.js";
7
7
  import { FundraiseDataConfidenceSchema } from "../fundraise/data-confidence.js";
8
8
  import { FundraiseTransactionStatusSchema } from "../fundraise/transaction-status.js";
9
9
  const EntityAcquisitionSchemaDefinition = z.object({
10
- /** Acquired company — read-only nested display projection of the scoped path entity. */
10
+ /** The acquired company (the entity in the request path); read-only. */
11
11
  acquiredEntity: EntitySchema,
12
- /** Buyer — read-only nested display projection. Mutations identify the buyer only via the flat acquirerEntityId UUID, never a nested entity object. */
12
+ /** The buyer; read-only. Mutations identify the buyer only via the flat acquirerEntityId UUID, never a nested entity object. */
13
13
  acquirerEntity: EntitySchema,
14
14
  amount: z.number().int().nullish(),
15
15
  /** Acquisition announcement date or instant, retaining its stored precision. */
@@ -31,16 +31,16 @@ const EntityAcquisitionSchemaDefinition = z.object({
31
31
  currency: z.string().nullish(),
32
32
  dataConfidence: FundraiseDataConfidenceSchema.nullish(),
33
33
  evidence: EntityAcquisitionEvidenceSchema,
34
- /** Canonical fundraise transaction UUID */
34
+ /** Funding round id (UUID) */
35
35
  fundraiseTransactionId: z.uuid().nullish(),
36
- /** Type-safe identifier for fundraise investor joins */
36
+ /** Identifier of one investor's participation in a funding round */
37
37
  investorJoinId: z.uuid().nullish(),
38
38
  /** Whether the buyer still owns the acquired company, not whether the company is operating. False retains the prior ownership event on this relationship. */
39
39
  isCurrent: z.boolean().nullish(),
40
40
  /** Published page behind this acquisition, read from the provenance event that wrote it; absent for internal sources. */
41
41
  publicSource: EntityResearchPublicSourceSchema.nullish(),
42
42
  relationshipId: z.int(),
43
- /** Read stage of the acquired entity, not transactionStatus */
43
+ /** Acquisition stage of the acquired entity, not the deal's transactionStatus */
44
44
  status: EntityAcquisitionStageSchema,
45
45
  transactionStatus: FundraiseTransactionStatusSchema.nullish(),
46
46
  updatedAt: z.iso.datetime({ offset: true }).nullish(),
@@ -11,7 +11,7 @@ const EntityAnalysisReplaySchemaDefinition = z.object({
11
11
  entitySlug: z.string(),
12
12
  /** Retained legacy field, always empty. Conversation is withheld; publishedSection is a result, not a reply. */
13
13
  event: z.array(HarnessRunEventSchema),
14
- /** The accepted current visible snippet, with only canonical public source metadata. */
14
+ /** The accepted, current, visible snippet, with only its public source details. */
15
15
  publishedSection: EntityResearchSnippetSchema.nullish(),
16
16
  /** The single snippet type displayed by this public example. */
17
17
  section: z.array(z.string()),
@@ -461,7 +461,7 @@ type EntityBrandDefinition = z.infer<typeof EntityBrandSchemaDefinition>;
461
461
  export interface EntityBrandSchemaInput extends z.input<typeof EntityBrandSchemaDefinition> {
462
462
  }
463
463
  /**
464
- * Thin company brand read: names and logos under core, current website and social URLs, and current classification tags.
464
+ * Company brand summary: names and logos under core, current website and social URLs, and current classification tags.
465
465
  *
466
466
  * @openapiSchema EntityBrand
467
467
  * @endpoint GET /v1/entities/brand
@@ -14,7 +14,7 @@ const EntityBrandSchemaDefinition = z.object({
14
14
  urlLink: z.array(EntityUrlLinkSchema),
15
15
  });
16
16
  /**
17
- * Thin company brand read: names and logos under core, current website and social URLs, and current classification tags.
17
+ * Company brand summary: names and logos under core, current website and social URLs, and current classification tags.
18
18
  *
19
19
  * @openapiSchema EntityBrand
20
20
  * @endpoint GET /v1/entities/brand
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Competitive comparison signals for a provider entity — sells-to customers, pricing model, ownership, funding stage, total raised, and website. Projected from entity enrichment for side-by-side comparison; founded year rides the entity core.
3
+ * Competitive comparison signals for a provider entity — sells-to customers, pricing model, ownership, funding stage, total raised, and website. Taken from the entity's additional data for side-by-side comparison; the founding year is in the entity's core fields.
4
4
  *
5
5
  * @openapiSchema EntityComparisonSignals
6
6
  * @endpoint GET /v1/entities/lookup-exact
@@ -4,7 +4,7 @@ import { EntitySchema } from "./entity.js";
4
4
  import { EntityProfileStatusSchema } from "./profile-status.js";
5
5
  import { FundingStageSchema } from "../funding/stage.js";
6
6
  /**
7
- * Competitive comparison signals for a provider entity — sells-to customers, pricing model, ownership, funding stage, total raised, and website. Projected from entity enrichment for side-by-side comparison; founded year rides the entity core.
7
+ * Competitive comparison signals for a provider entity — sells-to customers, pricing model, ownership, funding stage, total raised, and website. Taken from the entity's additional data for side-by-side comparison; the founding year is in the entity's core fields.
8
8
  *
9
9
  * @openapiSchema EntityComparisonSignals
10
10
  * @endpoint GET /v1/entities/lookup-exact
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Full entity detail response: core entity, enrichment, governed research, relationships, external identifiers, fundraising, news, people, and sitemap eligibility. Core identity and naming fields live under core.
3
+ * Full entity detail: core fields, additional data, research, relationships, external identifiers, fundraising, news, people, and which profile pages exist. Identity and name fields are under core.
4
4
  *
5
5
  * @openapiSchema EntityDetail
6
6
  * @endpoint GET /v1/entities/lookup-exact
@@ -14,7 +14,7 @@ import { PersonDetailSchema } from "../person/detail.js";
14
14
  import { SearchAnswerSchema } from "../search/answer.js";
15
15
  import { UniqueIdSchema } from "../unique/id.js";
16
16
  /**
17
- * Full entity detail response: core entity, enrichment, governed research, relationships, external identifiers, fundraising, news, people, and sitemap eligibility. Core identity and naming fields live under core.
17
+ * Full entity detail: core fields, additional data, research, relationships, external identifiers, fundraising, news, people, and which profile pages exist. Identity and name fields are under core.
18
18
  *
19
19
  * @openapiSchema EntityDetail
20
20
  * @endpoint GET /v1/entities/lookup-exact
@@ -61,9 +61,9 @@ export const EntityDetailSchema = z.object({
61
61
  publicUrl: z.string().nullish(),
62
62
  /** Entity relationships. */
63
63
  relationship: z.array(EntityRelationshipSchema),
64
- /** Combined research disclosure: governed detail rows, snippets, and accelerator participation. */
64
+ /** Research findings: structured research details, written research snippets, and accelerator participation. */
65
65
  research: EntityResearchSchema,
66
- /** Sub-route eligibility computed once at the persistence boundary. */
66
+ /** Which of the entity's profile pages exist and are listed in the sitemap. */
67
67
  sitemap: EntitySitemapSchema,
68
68
  /** External registry identifiers associated with this entity. */
69
69
  uniqueId: z.array(UniqueIdSchema),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Flat entity core record — identity, naming, status, image, and source metadata. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations. Nested as .core inside EntityList for default list reads and EntityDetail for detail reads.
3
+ * Core fields of an entity: identity, names, status, image, and source details. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations. Nested as .core inside EntityList for default list reads and EntityDetail for detail reads.
4
4
  *
5
5
  * @openapiSchema Entity
6
6
  * @endpoint GET /v1/entities/brand
@@ -5,7 +5,7 @@ import { EntityNameAliasEntityAliasTypeSchema } from "./name-alias-entity-alias-
5
5
  import { EntitySitemapSchema } from "./sitemap.js";
6
6
  import { EntityTypeSchema } from "./type.js";
7
7
  /**
8
- * Flat entity core record — identity, naming, status, image, and source metadata. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations. Nested as .core inside EntityList for default list reads and EntityDetail for detail reads.
8
+ * Core fields of an entity: identity, names, status, image, and source details. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations. Nested as .core inside EntityList for default list reads and EntityDetail for detail reads.
9
9
  *
10
10
  * @openapiSchema Entity
11
11
  * @endpoint GET /v1/entities/brand
@@ -84,14 +84,14 @@ export const EntitySchema = z.object({
84
84
  nameLegal: z.string().nullish(),
85
85
  /** Current operating status. Use Acquired Subsidiary when the entity was acquired and still operates; use Closed (Acquihire) when the entity was acquired for its team and shut down, rendering like Closed everywhere; use Acquired only when it is terminal, folded, or closed. */
86
86
  operatingStatus: z.string().nullish(),
87
- /** Stable, immutable public handle (e.g. `eV1StGXR8Z5a`). Never changes once assigned, unlike the slug. Null on projections that do not select it and on rows still awaiting handle backfill. */
87
+ /** Stable, immutable public handle (e.g. `eV1StGXR8Z5a`). Never changes once assigned, unlike the slug. Null on responses that do not include it and on older records not yet given a handle. */
88
88
  publicId: z
89
89
  .string()
90
90
  .regex(/^e[0-9A-Za-z]{11}$/)
91
91
  .nullish(),
92
92
  /** Absolute public profile URL on the aVenture front-end, e.g. `https://aventure.vc/non-profits/{slug}`, derived from the typeRecord's canonical route family. Null when the route needs relationship context or the record has no direct public SSR route (Business Line, Organization, Product, Service, or a non-public slug). EntityDetail.publicUrl resolves Business Line parent context. A Product/Service has no standalone page: it is addressed only as `{providerPublicUrl}/products-services/{slug}` under its provider, because its slug is unique only per provider; the sitemap-urls slot paths already emit those child routes. */
93
93
  publicUrl: z.string().nullish(),
94
- /** Sub-route eligibility, populated by the sitemap projection. Null on non-sitemap reads to keep thin payloads compact. */
94
+ /** Which of the entity's profile pages exist and are listed in the sitemap; set only on sitemap reads and null otherwise to keep responses small. */
95
95
  sitemap: EntitySitemapSchema.nullish(),
96
96
  /** URL-safe identifier */
97
97
  slug: z
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Render control discriminator for filter UI components
3
+ * Kind of control to draw for this filter
4
4
  *
5
5
  * @openapiSchema EntityFilterControlType
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
- * Render control discriminator for filter UI components
4
+ * Kind of control to draw for this filter
5
5
  *
6
6
  * @openapiSchema EntityFilterControlType
7
7
  * @endpoint GET /v1/entities/filters
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * API response fragment for entity filter metadata
3
+ * Entity filter metadata
4
4
  *
5
5
  * @openapiSchema EntityFilterMeta
6
6
  * @endpoint GET /v1/entities/filters
@@ -4,7 +4,7 @@ import { EntityFilterRequestBindingSchema } from "./filter-request-binding.js";
4
4
  import { EntityFilterUiMetaSchema } from "./filter-ui-meta.js";
5
5
  import { EntityTypeSchema } from "./type.js";
6
6
  /**
7
- * API response fragment for entity filter metadata
7
+ * Entity filter metadata
8
8
  *
9
9
  * @openapiSchema EntityFilterMeta
10
10
  * @endpoint GET /v1/entities/filters
@@ -17,7 +17,7 @@ import { EntityTypeSchema } from "./type.js";
17
17
  export const EntityFilterMetaSchema = z.object({
18
18
  /** Concrete entity kinds supported by this facet, not a claim that each has recorded values. */
19
19
  applicableTypeRecord: z.array(EntityTypeSchema).nullish(),
20
- /** Executable binding in the EntityFilter request body; absent on older servers. */
20
+ /** Where this filter goes in the EntityFilter request body; absent on older servers. */
21
21
  requestBinding: EntityFilterRequestBindingSchema.nullish(),
22
22
  /** UI metadata for rendering entity filter controls */
23
23
  ui: EntityFilterUiMetaSchema.nullish(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Generator metadata for a filter payload
3
+ * Information about how this filter's option list was generated
4
4
  *
5
5
  * @openapiSchema EntityFilterOptionSetMeta
6
6
  * @endpoint GET /v1/entities/filters
@@ -4,7 +4,7 @@ import { EntityFilterOptionModeSchema } from "./filter-option-mode.js";
4
4
  import { EntityTypeGroupMembershipSchema } from "./type-group-membership.js";
5
5
  import { EntityTypeGroupSchema } from "./type-group.js";
6
6
  /**
7
- * Generator metadata for a filter payload
7
+ * Information about how this filter's option list was generated
8
8
  *
9
9
  * @openapiSchema EntityFilterOptionSetMeta
10
10
  * @endpoint GET /v1/entities/filters
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Canonical request value shape derived from the bound Kotlin property type.
3
+ * Kind of value this filter property takes in the request body.
4
4
  *
5
5
  * @openapiSchema EntityFilterRequestValueShape
6
6
  * @endpoint GET /v1/entities/filters
@@ -7,7 +7,7 @@ const EntityFilterRequestValueShapeSchemaKnownMembers = z.enum([
7
7
  "DECIMAL_RANGE_ARRAY",
8
8
  ]);
9
9
  /**
10
- * Canonical request value shape derived from the bound Kotlin property type.
10
+ * Kind of value this filter property takes in the request body.
11
11
  *
12
12
  * @openapiSchema EntityFilterRequestValueShape
13
13
  * @endpoint GET /v1/entities/filters