Skip to content

Ask in words

POST
/v1/ask/filter
curl --request POST \
--url https://beta-api.plune.ai/v1/ask/filter \
--header 'Content-Type: application/json' \
--cookie plune_session=<plune_session> \
--data '{ "text": "flaky critical cases" }'

A question of up to 500 characters becomes a filter of the case list to show BEFORE it is applied (#1292, AC-07..AC-12). The question is masked of secrets and sent to the project own AI key under its monthly limit; the call is a line of the AI ledger, no credits. The model may name the case filter keys only, never a person (assignee); its answer is checked against the filter vocabulary, so what comes back is a canonical query string, how many cases it finds now, and the parts not understood - never SQL, never a write. A person in a session only (403 for a token). 409 ai_not_connected / ai_disabled / ai_key_unreadable, 503 ai_platform_not_configured, 429 ai_budget_spent (the month) or member_limit / project_limit (the AI calls of the hour and the day, with Retry-After), 502 / 504 ai_provider_error with its reason - nothing applied. Nothing understood is an empty query with the whole question in notUnderstood; a question of punctuation only (?) is answered so without a call to the model, its tokens and cost null.

Media type application/json
object
text
required
string
>= 1 characters <= 500 characters
Example
{
"text": "flaky critical cases"
}

The filter to show

Media type application/json
object
query
required
string
notUnderstood
required

The parts of the question not applied, each up to 200 characters; the whole question (up to 500) when nothing was understood.

Array<string>
<= 10 items
notUnderstoodParts
required

The same parts, in the same order, each with why: release_or_date (the case filter has no releases or failure dates), environment (no browser, device or environment), person (no filter by a person), unknown_value (a value outside a key vocabulary), ambiguous, other (also the whole question when nothing was understood).

Array<object>
<= 10 items
object
text
required
string
<= 500 characters
reason
required
string
Allowed values: release_or_date environment person unknown_value ambiguous other
matched
required
integer
inputTokens
required
integer
nullable
outputTokens
required
integer
nullable
costUsd
required

null: the model has no price, or no call was made - never 0.

number
nullable
Example
{
"notUnderstoodParts": [
{
"reason": "release_or_date"
}
]
}

Invalid body or filter

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

A token, or a read-only member

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The project AI is not connected, is off, or its key cannot be read

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over

The provider failed, or its answer is not a filter

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The platform has no AI configured

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The provider did not answer within 60 s

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}