Skip to main content

Get Playground Session

GET 
/api/v1/pipelines/:pipeline_id/playground-session

Get a playground session for a user and pipeline.

Request​

Path Parameters

    pipeline_id uuidrequired

Cookie Parameters

    session any

Responses​

Successful Response

Schema

    id uuidrequired

    Unique identifier

    created_at

    object

    Creation datetime

    anyOf

    string

    updated_at

    object

    Update datetime

    anyOf

    string

    pipeline_id uuidrequired
    user_id User Id (string)required
    llm_params_id uuidrequired

    llm_params

    object

    LLM parameters last used in this session.

    model_name SupportedLLMModelNames (string)

    Possible values: [GPT_3_5_TURBO, GPT_4, GPT_4_TURBO, GPT_4O, GPT_4O_MINI, AZURE_OPENAI]

    Default value: GPT_3_5_TURBO

    The name of the model to use for LLM completions.

    system_prompt

    object

    The system prompt to use for the completion.

    anyOf

    string

    temperature

    object

    The temperature value for the model.

    anyOf

    number

    class_name Class Name (string)

    Default value: base_component

    retrieval_params_id uuidrequired

    retrieval_params

    object

    Schema for the search params for an retrieval execution that can be preset for a pipeline.

    dense_similarity_top_k

    object

    Number of nodes for dense retrieval.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    sparse_similarity_top_k

    object

    Number of nodes for sparse retrieval.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    enable_reranking

    object

    Enable reranking for retrieval

    anyOf

    boolean

    rerank_top_n

    object

    Number of reranked nodes for returning.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    alpha

    object

    Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.

    anyOf

    number

    Possible values: <= 1

    search_filters

    object

    Search filters for retrieval.

    anyOf

    filters

    object[]

    required

  • Array [

    • anyOf

    key Key (string)required

    value

    object

    required

    anyOf

    integer

    operator FilterOperator (string)

    Possible values: [==, >, <, !=, >=, <=, in, nin, any, all, text_match, contains, is_empty]

    Default value: ==

    Vector store filter operator.

  • ]

    • condition

    object

    anyOf

    string

    Possible values: [and, or]

    files_top_k

    object

    Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).

    anyOf

    integer

    Possible values: >= 1 and <= 5

    retrieval_mode RetrievalMode (string)

    Possible values: [chunks, files_via_metadata, files_via_content]

    Default value: chunks

    The retrieval mode for the query.

    retrieve_image_nodes Retrieve Image Nodes (boolean)

    Whether to retrieve image nodes.

    class_name Class Name (string)

    Default value: base_component

    chat_messages

    object[]

    Chat message history for this session.

  • Array [

    • id uuidrequired
    index Index (integer)required

    The index of the message in the chat.

    annotations

    object[]

    Retrieval annotations for the message.

  • Array [

    • type Type (string)required
    data Data (string)required
    class_name Class Name (string)

    Default value: base_component

  • ]

    • role MessageRole (string)required

    Possible values: [system, user, assistant, function, tool, chatbot, model]

    Message role.

    content

    object

    Text content of the generation

    anyOf

    string

    additional_kwargs

    object

    Additional arguments passed to the model

    property name* string
    class_name Class Name (string)

    Default value: base_component

  • ]

Loading...