@homeflare/distilled-litellm 0.2.0

package/src/services/search.ts

@@ -0,0 +1,260 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (pinned litellm-openapi @ 1.100.0 — see README). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as C from "@distilled.cloud/core/category";
+import * as T from "../traits.ts";
+import {
+  LitellmProtocol,
+  type LitellmOpError,
+  type LitellmOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { LitellmOpError, LitellmOpContext };
+
+export class UnprocessableEntity
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<UnprocessableEntity>()("UnprocessableEntity", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 422 }],
+  ) {}
+
+export interface ListSearchToolsSearchToolsGetRequest {}
+export const ListSearchToolsSearchToolsGetRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({}).pipe(
+      T.Http({ method: "GET", uri: "/search/tools", code: 200 }),
+    ),
+).annotate({
+  identifier: "ListSearchToolsSearchToolsGetRequest",
+}) as any as S.Schema<ListSearchToolsSearchToolsGetRequest>;
+
+export interface ListSearchToolsSearchToolsGetResponse {
+  body: unknown;
+}
+export const ListSearchToolsSearchToolsGetResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      body: S.Unknown,
+    }),
+).annotate({
+  identifier: "ListSearchToolsSearchToolsGetResponse",
+}) as any as S.Schema<ListSearchToolsSearchToolsGetResponse>;
+
+export interface ListSearchToolsV1SearchToolsGetRequest {}
+export const ListSearchToolsV1SearchToolsGetRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({}).pipe(
+      T.Http({ method: "GET", uri: "/v1/search/tools", code: 200 }),
+    ),
+).annotate({
+  identifier: "ListSearchToolsV1SearchToolsGetRequest",
+}) as any as S.Schema<ListSearchToolsV1SearchToolsGetRequest>;
+
+export interface ListSearchToolsV1SearchToolsGetResponse {
+  body: unknown;
+}
+export const ListSearchToolsV1SearchToolsGetResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      body: S.Unknown,
+    }),
+).annotate({
+  identifier: "ListSearchToolsV1SearchToolsGetResponse",
+}) as any as S.Schema<ListSearchToolsV1SearchToolsGetResponse>;
+
+export interface SearchSearchPostRequest {
+  search_tool_name?: string;
+}
+export const SearchSearchPostRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    search_tool_name: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "POST", uri: "/search", code: 200 })),
+).annotate({
+  identifier: "SearchSearchPostRequest",
+}) as any as S.Schema<SearchSearchPostRequest>;
+
+export interface SearchSearchPostResponse {
+  body: unknown;
+}
+export const SearchSearchPostResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    body: S.Unknown,
+  }),
+).annotate({
+  identifier: "SearchSearchPostResponse",
+}) as any as S.Schema<SearchSearchPostResponse>;
+
+export interface SearchSearchSearchToolNamePostRequest {
+  search_tool_name: string;
+}
+export const SearchSearchSearchToolNamePostRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      search_tool_name: S.String.pipe(T.Label()),
+    }).pipe(
+      T.Http({ method: "POST", uri: "/search/{search_tool_name}", code: 200 }),
+    ),
+).annotate({
+  identifier: "SearchSearchSearchToolNamePostRequest",
+}) as any as S.Schema<SearchSearchSearchToolNamePostRequest>;
+
+export interface SearchSearchSearchToolNamePostResponse {
+  body: unknown;
+}
+export const SearchSearchSearchToolNamePostResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      body: S.Unknown,
+    }),
+).annotate({
+  identifier: "SearchSearchSearchToolNamePostResponse",
+}) as any as S.Schema<SearchSearchSearchToolNamePostResponse>;
+
+export interface SearchV1SearchPostRequest {
+  search_tool_name?: string;
+}
+export const SearchV1SearchPostRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    search_tool_name: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "POST", uri: "/v1/search", code: 200 })),
+).annotate({
+  identifier: "SearchV1SearchPostRequest",
+}) as any as S.Schema<SearchV1SearchPostRequest>;
+
+export interface SearchV1SearchPostResponse {
+  body: unknown;
+}
+export const SearchV1SearchPostResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    body: S.Unknown,
+  }),
+).annotate({
+  identifier: "SearchV1SearchPostResponse",
+}) as any as S.Schema<SearchV1SearchPostResponse>;
+
+export interface SearchV1SearchSearchToolNamePostRequest {
+  search_tool_name: string;
+}
+export const SearchV1SearchSearchToolNamePostRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      search_tool_name: S.String.pipe(T.Label()),
+    }).pipe(
+      T.Http({
+        method: "POST",
+        uri: "/v1/search/{search_tool_name}",
+        code: 200,
+      }),
+    ),
+).annotate({
+  identifier: "SearchV1SearchSearchToolNamePostRequest",
+}) as any as S.Schema<SearchV1SearchSearchToolNamePostRequest>;
+
+export interface SearchV1SearchSearchToolNamePostResponse {
+  body: unknown;
+}
+export const SearchV1SearchSearchToolNamePostResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      body: S.Unknown,
+    }),
+).annotate({
+  identifier: "SearchV1SearchSearchToolNamePostResponse",
+}) as any as S.Schema<SearchV1SearchSearchToolNamePostResponse>;
+
+export type ListSearchToolsSearchToolsGetError = LitellmOpError;
+/** List Search Tools List all available search tools configured in the router. This endpoint returns the search tools that are currently loaded and available for use with the /v1/search endpoint. Example: ```bash curl -X GET "http://localhost:4000/v1/search/tools" -H "Authorization: Bearer sk-1234" ``` Response: ```json { "object": "list", "data": [ { "search_tool_name": "litellm-search", "search_provider": "perplexity", "description": "Perplexity search tool" } ] } ``` */
+export const listSearchToolsSearchToolsGet: API.OperationMethod<
+  ListSearchToolsSearchToolsGetRequest,
+  ListSearchToolsSearchToolsGetResponse,
+  ListSearchToolsSearchToolsGetError,
+  LitellmOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListSearchToolsSearchToolsGetRequest,
+  output: ListSearchToolsSearchToolsGetResponse,
+  errors: [],
+  protocol: LitellmProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListSearchToolsV1SearchToolsGetError = LitellmOpError;
+/** List Search Tools List all available search tools configured in the router. This endpoint returns the search tools that are currently loaded and available for use with the /v1/search endpoint. Example: ```bash curl -X GET "http://localhost:4000/v1/search/tools" -H "Authorization: Bearer sk-1234" ``` Response: ```json { "object": "list", "data": [ { "search_tool_name": "litellm-search", "search_provider": "perplexity", "description": "Perplexity search tool" } ] } ``` */
+export const listSearchToolsV1SearchToolsGet: API.OperationMethod<
+  ListSearchToolsV1SearchToolsGetRequest,
+  ListSearchToolsV1SearchToolsGetResponse,
+  ListSearchToolsV1SearchToolsGetError,
+  LitellmOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListSearchToolsV1SearchToolsGetRequest,
+  output: ListSearchToolsV1SearchToolsGetResponse,
+  errors: [],
+  protocol: LitellmProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchSearchPostError = UnprocessableEntity | LitellmOpError;
+/** Search Search endpoint for performing web searches. Follows the Perplexity Search API spec: https://docs.perplexity.ai/api-reference/search-post The search_tool_name can be passed either: 1. In the URL path: /v1/search/{search_tool_name} 2. In the request body: {"search_tool_name": "..."} Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible): ```bash curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Example with search_tool_name in body: ```bash curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "search_tool_name": "litellm-search", "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Request Body Parameters (when search_tool_name not in URL): - search_tool_name (str, required if not in URL): Name of the search tool configured in router - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') When using URL path parameter, only Perplexity-compatible parameters are needed in body: - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') Response follows Perplexity Search API format: ```json { "object": "search", "results": [ { "title": "Result title", "url": "https://example.com", "snippet": "Result snippet...", "date": "2024-01-01", "last_updated": "2024-01-01" } ] } ``` */
+export const searchSearchPost: API.OperationMethod<
+  SearchSearchPostRequest,
+  SearchSearchPostResponse,
+  SearchSearchPostError,
+  LitellmOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchSearchPostRequest,
+  output: SearchSearchPostResponse,
+  errors: [UnprocessableEntity],
+  protocol: LitellmProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchSearchSearchToolNamePostError =
+  | UnprocessableEntity
+  | LitellmOpError;
+/** Search Search endpoint for performing web searches. Follows the Perplexity Search API spec: https://docs.perplexity.ai/api-reference/search-post The search_tool_name can be passed either: 1. In the URL path: /v1/search/{search_tool_name} 2. In the request body: {"search_tool_name": "..."} Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible): ```bash curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Example with search_tool_name in body: ```bash curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "search_tool_name": "litellm-search", "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Request Body Parameters (when search_tool_name not in URL): - search_tool_name (str, required if not in URL): Name of the search tool configured in router - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') When using URL path parameter, only Perplexity-compatible parameters are needed in body: - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') Response follows Perplexity Search API format: ```json { "object": "search", "results": [ { "title": "Result title", "url": "https://example.com", "snippet": "Result snippet...", "date": "2024-01-01", "last_updated": "2024-01-01" } ] } ``` */
+export const searchSearchSearchToolNamePost: API.OperationMethod<
+  SearchSearchSearchToolNamePostRequest,
+  SearchSearchSearchToolNamePostResponse,
+  SearchSearchSearchToolNamePostError,
+  LitellmOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchSearchSearchToolNamePostRequest,
+  output: SearchSearchSearchToolNamePostResponse,
+  errors: [UnprocessableEntity],
+  protocol: LitellmProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchV1SearchPostError = UnprocessableEntity | LitellmOpError;
+/** Search Search endpoint for performing web searches. Follows the Perplexity Search API spec: https://docs.perplexity.ai/api-reference/search-post The search_tool_name can be passed either: 1. In the URL path: /v1/search/{search_tool_name} 2. In the request body: {"search_tool_name": "..."} Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible): ```bash curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Example with search_tool_name in body: ```bash curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "search_tool_name": "litellm-search", "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Request Body Parameters (when search_tool_name not in URL): - search_tool_name (str, required if not in URL): Name of the search tool configured in router - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') When using URL path parameter, only Perplexity-compatible parameters are needed in body: - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') Response follows Perplexity Search API format: ```json { "object": "search", "results": [ { "title": "Result title", "url": "https://example.com", "snippet": "Result snippet...", "date": "2024-01-01", "last_updated": "2024-01-01" } ] } ``` */
+export const searchV1SearchPost: API.OperationMethod<
+  SearchV1SearchPostRequest,
+  SearchV1SearchPostResponse,
+  SearchV1SearchPostError,
+  LitellmOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchV1SearchPostRequest,
+  output: SearchV1SearchPostResponse,
+  errors: [UnprocessableEntity],
+  protocol: LitellmProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchV1SearchSearchToolNamePostError =
+  | UnprocessableEntity
+  | LitellmOpError;
+/** Search Search endpoint for performing web searches. Follows the Perplexity Search API spec: https://docs.perplexity.ai/api-reference/search-post The search_tool_name can be passed either: 1. In the URL path: /v1/search/{search_tool_name} 2. In the request body: {"search_tool_name": "..."} Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible): ```bash curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Example with search_tool_name in body: ```bash curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{ "search_tool_name": "litellm-search", "query": "latest AI developments 2024", "max_results": 5, "search_domain_filter": ["arxiv.org", "nature.com"], "country": "US" }' ``` Request Body Parameters (when search_tool_name not in URL): - search_tool_name (str, required if not in URL): Name of the search tool configured in router - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') When using URL path parameter, only Perplexity-compatible parameters are needed in body: - query (str or list[str], required): Search query - max_results (int, optional): Maximum number of results (1-20), default 10 - search_domain_filter (list[str], optional): List of domains to filter (max 20) - max_tokens_per_page (int, optional): Max tokens per page, default 1024 - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE') Response follows Perplexity Search API format: ```json { "object": "search", "results": [ { "title": "Result title", "url": "https://example.com", "snippet": "Result snippet...", "date": "2024-01-01", "last_updated": "2024-01-01" } ] } ``` */
+export const searchV1SearchSearchToolNamePost: API.OperationMethod<
+  SearchV1SearchSearchToolNamePostRequest,
+  SearchV1SearchSearchToolNamePostResponse,
+  SearchV1SearchSearchToolNamePostError,
+  LitellmOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchV1SearchSearchToolNamePostRequest,
+  output: SearchV1SearchSearchToolNamePostResponse,
+  errors: [UnprocessableEntity],
+  protocol: LitellmProtocol,
+  retry: Retry.Retry,
+}));