Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sdks/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,9 @@ results = await client.search.query(
"API documentation",
filters=SearchFilters(
data_sources=["api-docs.pdf"],
document_types=["application/pdf"]
document_types=["application/pdf"],
owners=["user@example.com"],
connector_types=["google_drive"],
),
limit=5,
score_threshold=0.5
Expand Down
13 changes: 6 additions & 7 deletions sdks/python/openrag_sdk/chat.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
"""OpenRAG SDK chat client with streaming support."""

import json
from typing import TYPE_CHECKING, Any, AsyncIterator, Literal, overload
from collections.abc import AsyncIterator
from typing import TYPE_CHECKING, Any, Literal, overload

import httpx

Expand Down Expand Up @@ -253,7 +254,8 @@ async def create(
message: The message to send.
stream: Whether to stream the response (default False).
chat_id: ID of existing conversation to continue.
filters: Optional search filters (data_sources, document_types).
filters: Optional search filters (data_sources, document_types, owners,
connector_types).
limit: Maximum number of search results (default 10).
score_threshold: Minimum search score threshold (default 0).
filter_id: Optional knowledge filter ID to apply.
Expand Down Expand Up @@ -414,7 +416,8 @@ def stream(
Args:
message: The message to send.
chat_id: ID of existing conversation to continue.
filters: Optional search filters (data_sources, document_types).
filters: Optional search filters (data_sources, document_types, owners,
connector_types).
limit: Maximum number of search results (default 10).
score_threshold: Minimum search score threshold (default 0).
filter_id: Optional knowledge filter ID to apply.
Expand Down Expand Up @@ -500,7 +503,3 @@ async def delete(self, chat_id: str) -> bool:
return data.get("success", False)
except NotFoundError:
return False


# Import Literal for type hints
from typing import Literal
2 changes: 2 additions & 0 deletions sdks/python/openrag_sdk/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,8 @@ class SearchFilters(BaseModel):

data_sources: list[str] | None = None
document_types: list[str] | None = None
owners: list[str] | None = None
connector_types: list[str] | None = None


# Settings update models
Expand Down
5 changes: 2 additions & 3 deletions sdks/python/openrag_sdk/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

from typing import TYPE_CHECKING, Any

import httpx

from .models import SearchFilters, SearchResponse, SearchResult

if TYPE_CHECKING:
Expand All @@ -30,7 +28,8 @@ async def query(

Args:
query: The search query text.
filters: Optional filters (data_sources, document_types).
filters: Optional filters (data_sources, document_types, owners,
connector_types).
limit: Maximum number of results (default 10).
score_threshold: Minimum score threshold (default 0).
filter_id: Optional knowledge filter ID to apply.
Expand Down
17 changes: 17 additions & 0 deletions sdks/python/tests/test_models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from openrag_sdk import SearchFilters


def test_search_filters_include_owner_and_connector_filters():
filters = SearchFilters(
data_sources=["api-docs.pdf"],
document_types=["application/pdf"],
owners=["user@example.com"],
connector_types=["google_drive"],
)

assert filters.model_dump(exclude_none=True) == {
"data_sources": ["api-docs.pdf"],
"document_types": ["application/pdf"],
"owners": ["user@example.com"],
"connector_types": ["google_drive"],
}
2 changes: 2 additions & 0 deletions sdks/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,8 @@ const results = await client.search.query("API documentation", {
filters: {
data_sources: ["api-docs.pdf"],
document_types: ["application/pdf"],
owners: ["user@example.com"],
connector_types: ["google_drive"],
},
limit: 5,
scoreThreshold: 0.5,
Expand Down
2 changes: 2 additions & 0 deletions sdks/typescript/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ export interface SearchResponse {
export interface SearchFilters {
data_sources?: string[];
document_types?: string[];
owners?: string[];
connector_types?: string[];
}

// Document types
Expand Down
20 changes: 20 additions & 0 deletions sdks/typescript/tests/types.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { describe, expect, it } from "vitest";
import type { SearchFilters } from "../src";

describe("SearchFilters", () => {
it("accepts owner and connector type filters", () => {
const filters: SearchFilters = {
data_sources: ["api-docs.pdf"],
document_types: ["application/pdf"],
owners: ["user@example.com"],
connector_types: ["google_drive"],
};

expect(filters).toEqual({
data_sources: ["api-docs.pdf"],
document_types: ["application/pdf"],
owners: ["user@example.com"],
connector_types: ["google_drive"],
});
});
});
Loading