Crossing Minds API
  • Documentation
      • Low Level HTTP Walkthrough
      • API Entities
      • DIY API Tutorial - MovieLens
      • Authentication
      • Items and Users Properties
      • Flexible Identifiers
      • Business Rules and Scenarios
      • Reranking on Item Property
      • Filtering on Item Property
      • Filtering on User Property
      • Error Handling
      • API Endpoints
      • Under the Hood
  • Page
      • [Internal] Chat Item Search
        • [Internal] Chat Message
  • « [Internal] Analytics
  • [Internal] LLM »
  • [Internal] Chat Item Search
    • [Internal] Chat Message

[Internal] Chat Item Search¶

LLM Chat Item Search for GPT Spotlight.

[Internal] Chat Message¶

POST chat/message-parts-stream/¶

Note

Authorized Roles: root, manager, backend, frontend

Note: If both the cursor and the message are empty, the endpoint will check the rate limit

and return an empty response.

Request JSON Object
  • scenario (string) – Optional. Name of scenario to apply [see About Scenarios]

  • skip_default_scenario (bool) – Optional. Specify whether default scenario should by applied or skipped [see Default Scenario]

  • user_id (ID) – Optional. [see Flexible Identifiers], [max_length: 64] User ID

  • session_id (ID) – Optional. [see Flexible Identifiers], [max_length: 64] Anonymous Session ID

  • user_message (string) – Optional.

  • cursor (string) – Optional.

  • amt (int) – Optional. [min: 0 max: 64] Maximum amount of items returned

EXAMPLE QUERY BODY¶
  {
      "todo": 1
  }
Response JSON Object
  • warnings (list-of-string) – Optional. List of warnings

  • uuid (string) –

  • reply (string) –

  • items (list-of-object) –

    Optional.

    Inner fields
    • item_id (ID) – [see Flexible Identifiers], [max_length: 64] Item ID

    • reason (string) –

  • next_cursor (string) – Optional.

  • evaluated_scenarios (object) –

    Optional.

    Inner fields
    • runtime (list-of-object) – List of evaluated scenarios from runtime scenario [see About Scenarios]

      Inner fields
      • scenario_type (enum) – choices: [case, ab_test, condition, alias] Type of scenario

      • scenario_name (string) – Name of scenario

      • to (string) – Characterization of next scenario evaluated

    • default (list-of-object) – List of evaluated scenarios from default scenario [see About Scenarios]

      Inner fields
      • scenario_type (enum) – choices: [case, ab_test, condition, alias] Type of scenario

      • scenario_name (string) – Name of scenario

      • to (string) – Characterization of next scenario evaluated

    • reco_type (enum) – choices: [item_to_items, profile_to_items, session_to_items, profile_to_item_properties, profile_to_items_w_ctx_items, session_to_items_w_ctx_items, precomputed_item_to_items, precomputed_profile_to_items, session_to_item_properties, profiles_group_to_items, chat_to_items, item_properties_to_items, generic_input_to_items, llm_text_completion, llm_chat_completion] Type of recommendation

    • generic_runtime (list-of-object) – List of evaluated generic scenarios from runtime scenario [see About Scenarios]

      Inner fields
      • scenario_type (enum) – choices: [case, ab_test, condition, alias] Type of scenario

      • scenario_name (string) – Name of scenario

      • to (string) – Characterization of next scenario evaluated

    • generic_default (list-of-object) – List of evaluated generic scenarios from default scenario [see About Scenarios]

      Inner fields
      • scenario_type (enum) – choices: [case, ab_test, condition, alias] Type of scenario

      • scenario_name (string) – Name of scenario

      • to (string) – Characterization of next scenario evaluated

EXAMPLE RESPONSE PART¶
  {
      "todo": 1
  }

Back to top

© Copyright 2020, Crossing Minds.