Skip to content

Add support for defining generative config at query-time (dynamic RAG) #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Mar 17, 2025
Merged
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
18 changes: 12 additions & 6 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,17 @@ on:

env:
WEAVIATE_124: 1.24.26
WEAVIATE_125: 1.25.30
WEAVIATE_126: 1.26.14
WEAVIATE_127: 1.27.11
WEAVIATE_128: 1.28.4
WEAVIATE_129: 1.29.0
WEAVIATE_125: 1.25.34
WEAVIATE_126: 1.26.17
WEAVIATE_127: 1.27.15
WEAVIATE_128: 1.28.11
WEAVIATE_129: 1.29.1
WEAVIATE_130: 1.30.0-dev-680e323

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
checks:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -43,7 +48,8 @@ jobs:
{ node: "22.x", weaviate: $WEAVIATE_128},
{ node: "18.x", weaviate: $WEAVIATE_129},
{ node: "20.x", weaviate: $WEAVIATE_129},
{ node: "22.x", weaviate: $WEAVIATE_129}
{ node: "22.x", weaviate: $WEAVIATE_129},
{ node: "22.x", weaviate: $WEAVIATE_130}
]
steps:
- uses: actions/checkout@v3
Expand Down
7 changes: 7 additions & 0 deletions src/collections/config/types/generative.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ export type GenerativeMistralConfig = {
temperature?: number;
};

export type GenerativeNvidiaConfig = {
baseURL?: string;
maxTokens?: number;
model?: string;
temperature?: number;
};

export type GenerativeOllamaConfig = {
apiEndpoint?: string;
model?: string;
Expand Down
18 changes: 18 additions & 0 deletions src/collections/configure/generative.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
GenerativeFriendliAIConfig,
GenerativeGoogleConfig,
GenerativeMistralConfig,
GenerativeNvidiaConfig,
GenerativeOllamaConfig,
GenerativeOpenAIConfig,
GenerativePaLMConfig,
Expand All @@ -22,6 +23,7 @@ import {
GenerativeDatabricksConfigCreate,
GenerativeFriendliAIConfigCreate,
GenerativeMistralConfigCreate,
GenerativeNvidiaConfigCreate,
GenerativeOllamaConfigCreate,
GenerativeOpenAIConfigCreate,
GenerativePaLMConfigCreate,
Expand Down Expand Up @@ -169,6 +171,22 @@ export default {
config,
};
},
/**
* Create a `ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined>` object for use when performing AI generation using the `generative-mistral` module.
*
* See the [documentation](https://weaviate.io/developers/weaviate/model-providers/nvidia/generative) for detailed usage.
*
* @param {GenerativeNvidiaConfigCreate} [config] The configuration for the `generative-nvidia` module.
* @returns {ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined>} The configuration object.
*/
nvidia(
config?: GenerativeNvidiaConfigCreate
): ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined> {
return {
name: 'generative-nvidia',
config,
};
},
/**
* Create a `ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined>` object for use when performing AI generation using the `generative-ollama` module.
*
Expand Down
6 changes: 6 additions & 0 deletions src/collections/configure/types/generative.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
GenerativeDatabricksConfig,
GenerativeFriendliAIConfig,
GenerativeMistralConfig,
GenerativeNvidiaConfig,
GenerativeOllamaConfig,
GenerativePaLMConfig,
} from '../../index.js';
Expand Down Expand Up @@ -44,6 +45,8 @@ export type GenerativeFriendliAIConfigCreate = GenerativeFriendliAIConfig;

export type GenerativeMistralConfigCreate = GenerativeMistralConfig;

export type GenerativeNvidiaConfigCreate = GenerativeNvidiaConfig;

export type GenerativeOllamaConfigCreate = GenerativeOllamaConfig;

export type GenerativeOpenAIConfigCreate = GenerativeOpenAIConfigBaseCreate & {
Expand All @@ -61,6 +64,7 @@ export type GenerativeConfigCreate =
| GenerativeDatabricksConfigCreate
| GenerativeFriendliAIConfigCreate
| GenerativeMistralConfigCreate
| GenerativeNvidiaConfigCreate
| GenerativeOllamaConfigCreate
| GenerativeOpenAIConfigCreate
| GenerativePaLMConfigCreate
Expand All @@ -81,6 +85,8 @@ export type GenerativeConfigCreateType<G> = G extends 'generative-anthropic'
? GenerativeFriendliAIConfigCreate
: G extends 'generative-mistral'
? GenerativeMistralConfigCreate
: G extends 'generative-nvidia'
? GenerativeNvidiaConfigCreate
: G extends 'generative-ollama'
? GenerativeOllamaConfigCreate
: G extends 'generative-openai'
Expand Down
36 changes: 31 additions & 5 deletions src/collections/deserialize/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import {
AggregateResult,
AggregateText,
AggregateType,
GenerativeConfigRuntime,
GenerativeMetadata,
PropertiesMetrics,
} from '../index.js';
import { referenceFromObjects } from '../references/utils.js';
Expand Down Expand Up @@ -207,19 +209,43 @@ export class Deserialize {
};
}

public generate<T>(reply: SearchReply): GenerativeReturn<T> {
public generate<T, C extends GenerativeConfigRuntime | undefined>(
reply: SearchReply
): GenerativeReturn<T, C> {
return {
objects: reply.results.map((result) => {
return {
generated: result.metadata?.generativePresent ? result.metadata?.generative : undefined,
generated: result.metadata?.generativePresent
? result.metadata?.generative
: result.generative
? result.generative.values[0].result
: undefined,
generative: result.generative
? {
text: result.generative.values[0].result,
debug: result.generative.values[0].debug,
metadata: result.generative.values[0].metadata as GenerativeMetadata<C>,
}
: undefined,
metadata: Deserialize.metadata(result.metadata),
properties: this.properties(result.properties),
references: this.references(result.properties),
uuid: Deserialize.uuid(result.metadata),
vectors: Deserialize.vectors(result.metadata),
} as any;
}),
generated: reply.generativeGroupedResult,
generated:
reply.generativeGroupedResult !== ''
? reply.generativeGroupedResult
: reply.generativeGroupedResults
? reply.generativeGroupedResults.values[0].result
: undefined,
generative: reply.generativeGroupedResults
? {
text: reply.generativeGroupedResults?.values[0].result,
metadata: reply.generativeGroupedResults?.values[0].metadata as GenerativeMetadata<C>,
}
: undefined,
};
}

Expand Down Expand Up @@ -252,9 +278,9 @@ export class Deserialize {
};
}

public generateGroupBy<T>(reply: SearchReply): GenerativeGroupByReturn<T> {
public generateGroupBy<T>(reply: SearchReply): GenerativeGroupByReturn<T, any> {
const objects: GroupByObject<T>[] = [];
const groups: Record<string, GenerativeGroupByResult<T>> = {};
const groups: Record<string, GenerativeGroupByResult<T, any>> = {};
reply.groupByResults.forEach((result) => {
const objs = result.objects.map((object) => {
return {
Expand Down
Loading