generated: '2026-10-07'
method: derived
generator: derive-vocabulary.py
source: openapi/octen-ai-openapi.yml
vocabulary:
  name: Octen Domain Vocabulary
  description: 'Terms declared by Octen''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-07'
  terms:
  - term: SearchRequest
    definition: 'Object declared by the contract with fields: query.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SearchRequest
  - term: HighlightOptions
    definition: Controls highlight extraction from result pages.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/HighlightOptions
  - term: FullContentOptions
    definition: Controls whether to return the full raw content of each result page.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/FullContentOptions
  - term: SearchResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SearchResponse
  - term: SearchData
    definition: The main response payload.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SearchData
  - term: SearchResult
    definition: A single search result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SearchResult
  - term: SearchMeta
    definition: Additional metadata for the search request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SearchMeta
  - term: SearchUsage
    definition: Usage information for the search request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SearchUsage
  - term: NewsSearchRequest
    definition: 'Object declared by the contract with fields: query, count, include_domains, exclude_domains, time_basis, time_range, start_time,
      end_time, language, highlight, full_content, subjects.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSearchRequest
  - term: NewsSubjectOptions
    definition: Controls subject grouping, which clusters related articles into events.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSubjectOptions
  - term: NewsSearchResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSearchResponse
  - term: NewsSearchData
    definition: The main response payload.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSearchData
  - term: NewsSearchResult
    definition: A single news result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSearchResult
  - term: NewsImage
    definition: An image attached to an article.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsImage
  - term: NewsSubject
    definition: A group of related articles covering one event.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSubject
  - term: NewsSubjectTopNews
    definition: The representative article for the subject.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSubjectTopNews
  - term: NewsSubjectSubNews
    definition: The article representing one sub-event.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSubjectSubNews
  - term: NewsSearchMeta
    definition: Additional metadata for the search request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSearchMeta
  - term: NewsSearchUsage
    definition: Usage information for the search request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/NewsSearchUsage
  - term: BusinessSearchRequest
    definition: 'Object declared by the contract with fields: query, count, include_domains, exclude_domains, time_basis, time_range, start_time,
      end_time, language, highlight, full_content, entities.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessSearchRequest
  - term: BusinessEntityOptions
    definition: Controls the entity cards returned for companies and people.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessEntityOptions
  - term: BusinessSearchResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessSearchResponse
  - term: BusinessSearchData
    definition: The main response payload. Fields without data are omitted, at every level.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessSearchData
  - term: BusinessSearchResult
    definition: A single business result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessSearchResult
  - term: BusinessImage
    definition: An image attached to a page.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessImage
  - term: Company
    definition: 'Object declared by the contract with fields: type, name, summary, aliases, identifiers, attributes, metrics, key_people, logo,
      activities.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessCompanyEntity
  - term: Person
    definition: 'Object declared by the contract with fields: type, name, summary, linkedin_url, current_position, career, photo, activities.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessPersonEntity
  - term: BusinessEntityIdentifiers
    definition: Identifiers for the company.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessEntityIdentifiers
  - term: BusinessEntityAttributes
    definition: Basic attributes of the company.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessEntityAttributes
  - term: BusinessEntityMetrics
    definition: Quantitative metrics for the company.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessEntityMetrics
  - term: BusinessFinancials
    definition: Financial results for one reporting period.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessFinancials
  - term: BusinessStock
    definition: Live stock data from Octen. Returned for listed companies.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessStock
  - term: BusinessWebTraffic
    definition: Web traffic for the company's website.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessWebTraffic
  - term: BusinessKeyPerson
    definition: A key person at the company.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessKeyPerson
  - term: BusinessCareerEntry
    definition: One role in a person's career history.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessCareerEntry
  - term: BusinessSearchMeta
    definition: Additional metadata for the search request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessSearchMeta
  - term: BusinessSearchUsage
    definition: Usage information for the search request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BusinessSearchUsage
  - term: BroadSearchRequest
    definition: 'Object declared by the contract with fields: query, max_queries, search_options.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BroadSearchRequest
  - term: BroadSearchData
    definition: The main response payload.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BroadSearchData
  - term: BroadSearchResponse
    definition: 'Object declared by the contract with fields: code, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/BroadSearchResponse
  - term: ExtractRequest
    definition: Request body for the Extract API.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractRequest
  - term: ExtractResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractResponse
  - term: ExtractData
    definition: The main extract response payload.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractData
  - term: ExtractResult
    definition: 'A single extraction result. Batch requests may return 200 OK overall while individual items fail; failed items are marked with
      `status: "failed"` and an `error_message`, and are not billed.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractResult
  - term: ExtractPageStructure
    definition: Detected page structure for an extraction result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractPageStructure
  - term: ExtractCategory
    definition: Detected content category for an extraction result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractCategory
  - term: ExtractMediaResource
    definition: A single multimedia resource detected on the page.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractMediaResource
  - term: ExtractLink
    definition: A single link found on the page.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractLink
  - term: ExtractMeta
    definition: Additional metadata for the extract request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractMeta
  - term: ExtractUsage
    definition: Usage and billing breakdown for the extract request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ExtractUsage
  - term: EmbeddingRequest
    definition: 'Object declared by the contract with fields: input, model, dimension, input_type.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/EmbeddingRequest
  - term: EmbeddingResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/EmbeddingResponse
  - term: EmbeddingData
    definition: The main embedding response payload.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/EmbeddingData
  - term: EmbeddingResult
    definition: A single embedding result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/EmbeddingResult
  - term: EmbeddingMeta
    definition: Additional metadata for the embedding request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/EmbeddingMeta
  - term: EmbeddingUsage
    definition: Usage information for the embedding request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/EmbeddingUsage
  - term: VLEmbeddingRequest
    definition: 'Object declared by the contract with fields: model, input, enable_fusion, dimension, fps, instruct.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingRequest
  - term: VLEmbeddingInput
    definition: 'The multimodal content to be vectorized. Supports text, images, videos, and combinations. Maximum total elements per request:
      20. Maximum images per request: 5. Maximum videos per request: 1.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingInput
  - term: VLEmbeddingContent
    definition: A single content element. Each object should provide exactly one of `text`, `image`, or `video`. For multiple images, include
      multiple content objects (one image per object).
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingContent
  - term: VLEmbeddingResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id, data, meta.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingResponse
  - term: VLEmbeddingData
    definition: The main VL embedding response payload.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingData
  - term: VLEmbeddingResult
    definition: A single VL embedding result.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingResult
  - term: VLEmbeddingMeta
    definition: Additional metadata for the VL embedding request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingMeta
  - term: VLEmbeddingUsage
    definition: Usage information for the VL embedding request.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/VLEmbeddingUsage
  - term: ErrorResponse
    definition: 'Object declared by the contract with fields: code, msg, request_id.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ErrorResponse
  - term: ChatCompletionRequest
    definition: Request body for the Chat Completions API. Some parameters apply only to certain models; unsupported parameters are ignored for
      the selected model.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatCompletionRequest
  - term: SystemMessage
    definition: 'Object declared by the contract with fields: role, content.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/SystemMessage
  - term: UserMessage
    definition: 'Object declared by the contract with fields: role, content.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/UserMessage
  - term: AssistantMessage
    definition: 'Object declared by the contract with fields: role, content, tool_calls.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/AssistantMessage
  - term: ToolMessage
    definition: 'Object declared by the contract with fields: role, tool_call_id, content.'
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ToolMessage
  - term: ChatToolCall
    definition: A custom function call generated by the model.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatToolCall
  - term: ChatToolCallFunction
    definition: The function invocation details within a tool call.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatToolCallFunction
  - term: ChatContentBlock
    definition: A content block within a message.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatContentBlock
  - term: ChatResponseFormat
    definition: Controls the output format. Some models may not support structured output and will automatically fall back to `text`.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatResponseFormat
  - term: ChatReasoningOptions
    definition: Options for reasoning models. Turns thinking on or off and sets the effort and budget.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatReasoningOptions
  - term: ChatFunctionTool
    definition: A custom function tool, executed by the caller.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatFunctionTool
  - term: ChatOctenBroadSearchTool
    definition: The built-in `octen_broad_search` server tool, executed by Octen.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatOctenBroadSearchTool
  - term: ChatOctenSearchTool
    definition: The built-in `octen_search` server tool, executed by Octen.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatOctenSearchTool
  - term: ChatToolDefinition
    definition: A tool definition. One of a custom `function` tool, the built-in `octen_broad_search` tool, or the `octen_search` tool.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatToolDefinition
  - term: ChatFunctionDefinition
    definition: A custom function definition.
    tags:
    - Object
    source: openapi/octen-ai-openapi.yml#/components/schemas/ChatFunctionDefinition