Retrieve contexts from chosen knowledge base

Retrieve related documents from knowledge base by similarity.

post/serverless/v1/knowledge/retrieve

Request

Base URL
https://api.friendli.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/friendli/apis/friendli-suite-api-reference/docs/serverless/v1/knowledge/retrieve/post.ts
A function with typed inputs. Its response is checked against the schema.

X-Friendli-Teamstring nullable

ID of team to run requests as (optional parameter).

querystring required

A text string used to find relevant information within the knowledge-base.

kinteger required

Maximum number of top-ranked knowledge-base entries to return in results.

knowledgeIdsstring[] required

A List of knowledge-base IDs. For now, only one knowledge-base is supported.

{
  "query": "Chicken dinner",
  "k": 1,
  "knowledgeIds": [
    "knowledge-base-id-1"
  ]
}

Successful Response

No recorded changes to this operation across all 1 revision of this API.