Contents x
    /api/v2/query/reformulation
    • 03 Oct 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    /api/v2/query/reformulation

    • Updated on 03 Oct 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /api/v2/query/reformulation

    This endpoint can be used to reformulate a query in order to enhance retrieval.

    The query should be a single string or a list of string with up to 10 queries.

    The model field should be the name of the model to use for query formulation.

    Security
    API Key
    Header parameter nameAuthorization

    Token-based authentication with required prefix 'Bearer '. For example: Bearer <api_key>

    Body parameters
    object

    Serializer for reformulating a query.

    query
    string Required
    model
    string

    Model to use for the reformulation, must exist and be configured from the admin. If no model is given, will try to use the "rewriter" model.

    Default"rewriter"
    object

    Serializer for reformulating a query.

    query
    string Required
    model
    string

    Model to use for the reformulation, must exist and be configured from the admin. If no model is given, will try to use the "rewriter" model.

    Default"rewriter"
    object

    Serializer for reformulating a query.

    query
    string Required
    model
    string

    Model to use for the reformulation, must exist and be configured from the admin. If no model is given, will try to use the "rewriter" model.

    Default"rewriter"
    Responses
    200
    Array of object
    object

    Serializer for the result of a the query reformulation function.

    query
    string
    reformulation
    string
    Was this article helpful?