Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 3.6 KB

README.md

File metadata and controls

54 lines (38 loc) · 3.6 KB

Knowledge

(serverless.knowledge)

Overview

Available Operations

  • retrieve - Retrieve contexts from chosen knowledge base

retrieve

Retrieve related documents from knowledge base by similarity.

Example Usage

import os

from friendli import SyncFriendli

with SyncFriendli(
    token=os.getenv("FRIENDLI_TOKEN", ""),
) as friendli:
    res = friendli.serverless.knowledge.retrieve(
        k=1,
        knowledge_ids=[
            "knowledge-base-id-1",
        ],
        query="Chicken dinner",
    )

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
k int ✔️ Maximum number of top-ranked knowledge-base entries to return in results. 1
knowledge_ids List[str] ✔️ A List of knowledge-base IDs. For now, only one knowledge-base is supported. [
"knowledge-base-id-1"
]
query str ✔️ A text string used to find relevant information within the knowledge-base. Chicken dinner
x_friendli_team OptionalNullable[str] ➖ ID of team to run requests as (optional parameter).
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ServerlessKnowledgeRetrievalSuccess

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*