diff --git a/docs/index.html b/docs/index.html index b3ca4a2..c76e501 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - @webis-de/gen-ir-sim 0.5.3 | Documentation + @webis-de/gen-ir-sim 0.6.0 | Documentation @@ -15,7 +15,7 @@

@webis-de/gen-ir-sim

-
0.5.3
+
0.6.0
@webis-de/gen-ir-sim + +
  • + BasicChatSystem + + + + + +
  • +
    @@ -685,7 +713,7 @@

    - + src/index.js @@ -919,7 +947,7 @@

    - + src/index.js @@ -1141,7 +1169,7 @@

    - + src/index.js @@ -1322,7 +1350,7 @@

    - + src/evaluator.js @@ -1400,7 +1428,7 @@

    - + src/evaluator.js @@ -1519,7 +1547,7 @@

    - + src/evaluators/prompted-evaluator.js @@ -1652,7 +1680,7 @@

    - + src/evaluators/readability-evaluator.js @@ -1768,7 +1796,7 @@

    - + src/system.js @@ -1844,7 +1872,7 @@

    - + src/system.js @@ -1951,7 +1979,7 @@

    - + src/systems/generative-elastic-system.js @@ -2214,7 +2242,7 @@

    - + src/systems/generative-elastic-system.js @@ -2332,7 +2360,7 @@

    - + src/user.js @@ -2410,7 +2438,7 @@

    - + src/user.js @@ -2519,7 +2547,7 @@

    - + src/user.js @@ -2634,7 +2662,7 @@

    - + src/users/static-user.js @@ -2781,7 +2809,7 @@

    - + src/templates.js @@ -2831,7 +2859,7 @@

    - + src/templates.js @@ -2955,7 +2983,7 @@

    - + src/templates.js @@ -3035,7 +3063,7 @@

    - + src/templates.js @@ -3126,7 +3154,7 @@

    - + src/templates.js @@ -3233,7 +3261,7 @@

    - + src/index.js @@ -3348,7 +3376,7 @@

    - + src/evaluator.js @@ -3428,7 +3456,7 @@

    - + src/evaluator.js @@ -3478,7 +3506,7 @@

    - + src/evaluator.js @@ -3536,7 +3564,7 @@

    - + src/evaluator.js @@ -3604,7 +3632,7 @@

    - + src/llm.js @@ -3679,7 +3707,7 @@

    - + src/llm.js @@ -3759,7 +3787,7 @@

    - + src/llm.js @@ -3839,7 +3867,7 @@

    - + src/llm.js @@ -3919,7 +3947,7 @@

    - + src/llm.js @@ -4017,7 +4045,7 @@

    - + src/llm.js @@ -4146,7 +4174,7 @@

    - + src/llm.js @@ -4229,7 +4257,7 @@

    - + src/logbook.js @@ -4317,7 +4345,7 @@

    - + src/logbook.js @@ -4415,7 +4443,7 @@

    - + src/logbook.js @@ -4500,7 +4528,7 @@

    - + src/logbook.js @@ -4563,7 +4591,7 @@

    - + src/logbook.js @@ -4626,7 +4654,7 @@

    - + src/logbook.js @@ -4689,7 +4717,7 @@

    - + src/logbook.js @@ -4761,7 +4789,7 @@

    - + src/logbook.js @@ -4842,7 +4870,7 @@

    - + src/logbook.js @@ -4908,7 +4936,7 @@

    - + src/logbook.js @@ -4974,7 +5002,7 @@

    - + src/logbook.js @@ -5048,7 +5076,7 @@

    - + src/index.js @@ -5137,7 +5165,7 @@

    - + src/system.js @@ -5209,7 +5237,7 @@

    - + src/system.js @@ -5259,7 +5287,7 @@

    - + src/system.js @@ -5317,7 +5345,7 @@

    - + src/system.js @@ -5375,7 +5403,7 @@

    - + src/system.js @@ -5443,7 +5471,7 @@

    - + src/index.js @@ -5515,7 +5543,7 @@

    - + src/user.js @@ -5604,7 +5632,7 @@

    - + src/user.js @@ -5654,7 +5682,7 @@

    - + src/user.js @@ -5712,7 +5740,7 @@

    - + src/user.js @@ -5780,7 +5808,7 @@

    - + src/users/touche25-rad-user.js @@ -5877,6 +5905,227 @@

    + + + + + +
    + + +
    + +

    + BasicChatSystem +

    + + + + src/systems/basic-chat-system.js + + +
    + + +

    A blackbox retrieval system that implements a basic chat API.

    +

    The API needs to consume a JSON object that has at least the property +messages, which is an array of message objects. Each message object has +the string property role, which is either assistant or user, and the +string property content that contains the message text.

    +

    The API produces a JSON object that has at least the property message, +which is the response message (thus role has to be assistant).

    + +
    new BasicChatSystem(configuration: Object, log: Logbook)
    + + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + configuration (Object) + The configuration for the system + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescription
    configuration.url string + The URL of the chat endpoint +
    configuration.request string + The object that is sent to the +endpoint on each query with the messages added +
    + +
    + +
    +
    + log (Logbook) + A function that takes log messages + +
    + +
    + +
    + + + + + + + + + + + + + + + +
    Instance Members
    +
    + +
    +
    +
    + + search(userTurn, logbook) +
    +
    + +
    + +
    + + + + + +
    diff --git a/package-lock.json b/package-lock.json index da4fdad..bd82732 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@webis-de/gen-ir-sim", - "version": "0.5.3", + "version": "0.6.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@webis-de/gen-ir-sim", - "version": "0.5.3", + "version": "0.6.0", "license": "MIT", "dependencies": { "jsonrepair": "^3.8.0", @@ -14,6 +14,7 @@ }, "bin": { "genirsim": "bin/genirsim.js", + "genirsim-evaluate": "bin/genirsim-evaluate.js", "genirsim-server": "bin/genirsim-server.js" } },