Skip to content

Add missing modules to v3 client #140

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 3 commits into from
May 15, 2024
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
3 changes: 2 additions & 1 deletion src/collections/config/types/generative.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
type GenerativeOpenAIConfigBase = {
baseURL?: string;
frequencyPenaltyProperty?: number;
presencePenaltyProperty?: number;
maxTokensProperty?: number;
presencePenaltyProperty?: number;
temperatureProperty?: number;
topPProperty?: number;
};
Expand Down
7 changes: 5 additions & 2 deletions src/collections/config/types/vectorizer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ export type Multi2VecBindConfig = {

export type Multi2VecPalmConfig = {
projectId: string;
imageFields?: string[];
textFields?: string[];
videoFields?: string[];
location?: string;
modelId?: string;
dimensions?: number;
Expand Down Expand Up @@ -122,7 +125,7 @@ export type Text2VecOpenAIConfig = {
export type Text2VecPalmConfig = {
apiEndpoint?: string;
modelId?: string;
projectId: string;
projectId?: string;
vectorizeCollectionName?: boolean;
};

Expand Down Expand Up @@ -167,7 +170,7 @@ export type VectorizerConfigType<V> = V extends 'img2vec-neural'
: V extends 'text2vec-azure-openai'
? Text2VecAzureOpenAIConfig
: V extends 'text2vec-palm'
? Text2VecPalmConfig
? Text2VecPalmConfig | undefined
: V extends 'text2vec-transformers'
? Text2VecTransformersConfig | undefined
: V extends 'text2vec-voyageai'
Expand Down
56 changes: 45 additions & 11 deletions src/collections/configure/generative.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,65 +5,99 @@ import {
GenerativePaLMConfig,
ModuleConfig,
} from '../config/types/index.js';
import {
GenerativeAzureOpenAIConfigCreate,
GenerativeCohereConfigCreate,
GenerativeOpenAIConfigCreate,
GenerativePaLMConfigCreate,
} from '../index.js';

export default {
/**
* Create a `ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>` object for use when performing AI generation using the `generative-openai` module.
*
* See the [documentation](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-openai) for detailed usage.
*
* @param {GenerativeAzureOpenAIConfig} config The configuration for the `generative-openai` module.
* @param {GenerativeAzureOpenAIConfigCreate} config The configuration for the `generative-openai` module.
* @returns {ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>} The configuration object.
*/
azureOpenAI: (
config: GenerativeAzureOpenAIConfig
config: GenerativeAzureOpenAIConfigCreate
): ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig> => {
return {
name: 'generative-openai',
config: config,
config: {
deploymentId: config.deploymentId,
resourceName: config.resourceName,
baseURL: config.baseURL,
frequencyPenaltyProperty: config.frequencyPenalty,
maxTokensProperty: config.maxTokens,
presencePenaltyProperty: config.presencePenalty,
temperatureProperty: config.temperature,
topPProperty: config.topP,
},
};
},
/**
* Create a `ModuleConfig<'generative-cohere', GenerativeCohereConfig>` object for use when performing AI generation using the `generative-cohere` module.
*
* See the [documentation](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-cohere) for detailed usage.
*
* @param {GenerativeCohereConfig} [config] The configuration for the `generative-cohere` module.
* @param {GenerativeCohereConfigCreate} [config] The configuration for the `generative-cohere` module.
* @returns {ModuleConfig<'generative-cohere', GenerativeCohereConfig>} The configuration object.
*/
cohere: (
config?: GenerativeCohereConfig
config?: GenerativeCohereConfigCreate
): ModuleConfig<'generative-cohere', GenerativeCohereConfig | undefined> => {
return {
name: 'generative-cohere',
config: config,
config: config
? {
kProperty: config.k,
maxTokensProperty: config.maxTokens,
model: config.model,
returnLikelihoodsProperty: config.returnLikelihoods,
stopSequencesProperty: config.stopSequences,
temperatureProperty: config.temperature,
}
: undefined,
};
},
/**
* Create a `ModuleConfig<'generative-openai', GenerativeOpenAIConfig>` object for use when performing AI generation using the `generative-openai` module.
*
* See the [documentation](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-openai) for detailed usage.
*
* @param {GenerativeOpenAIConfig} [config] The configuration for the `generative-openai` module.
* @param {GenerativeOpenAIConfigCreate} [config] The configuration for the `generative-openai` module.
* @returns {ModuleConfig<'generative-openai', GenerativeOpenAIConfig>} The configuration object.
*/
openAI: (
config?: GenerativeOpenAIConfig
config?: GenerativeOpenAIConfigCreate
): ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined> => {
return {
name: 'generative-openai',
config: config,
config: config
? {
baseURL: config.baseURL,
frequencyPenaltyProperty: config.frequencyPenalty,
maxTokensProperty: config.maxTokens,
model: config.model,
presencePenaltyProperty: config.presencePenalty,
temperatureProperty: config.temperature,
topPProperty: config.topP,
}
: undefined,
};
},
/**
* Create a `ModuleConfig<'generative-palm', GenerativePaLMConfig>` object for use when performing AI generation using the `generative-palm` module.
*
* See the [documentation](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-palm) for detailed usage.
*
* @param {GenerativePaLMConfig} config The configuration for the `generative-palm` module.
* @param {GenerativePaLMConfigCreate} config The configuration for the `generative-palm` module.
* @returns {ModuleConfig<'generative-palm', GenerativePaLMConfig>} The configuration object.
*/
palm: (config: GenerativePaLMConfig): ModuleConfig<'generative-palm', GenerativePaLMConfig> => {
palm: (config: GenerativePaLMConfigCreate): ModuleConfig<'generative-palm', GenerativePaLMConfig> => {
return {
name: 'generative-palm',
config: config,
Expand Down
47 changes: 47 additions & 0 deletions src/collections/configure/types/generative.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { GenerativePaLMConfig } from '../../index.js';

type GenerativeOpenAIConfigBaseCreate = {
baseURL?: string;
frequencyPenalty?: number;
maxTokens?: number;
presencePenalty?: number;
temperature?: number;
topP?: number;
};

export type GenerativeOpenAIConfigCreate = GenerativeOpenAIConfigBaseCreate & {
model?: string;
};

export type GenerativeAzureOpenAIConfigCreate = GenerativeOpenAIConfigBaseCreate & {
resourceName: string;
deploymentId: string;
};

export type GenerativeCohereConfigCreate = {
k?: number;
maxTokens?: number;
model?: string;
returnLikelihoods?: string;
stopSequences?: string[];
temperature?: number;
};

export type GenerativePaLMConfigCreate = GenerativePaLMConfig;

export type GenerativeConfigCreate =
| GenerativeOpenAIConfigCreate
| GenerativeCohereConfigCreate
| GenerativePaLMConfigCreate
| Record<string, any>
| undefined;

export type GenerativeConfigCreateType<G> = G extends 'generative-openai'
? GenerativeOpenAIConfigCreate
: G extends 'generative-cohere'
? GenerativeCohereConfigCreate
: G extends 'generative-palm'
? GenerativePaLMConfigCreate
: G extends 'none'
? undefined
: Record<string, any> | undefined;
1 change: 1 addition & 0 deletions src/collections/configure/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './base.js';
export * from './generative.js';
export * from './vectorIndex.js';
export * from './vectorizer.js';
15 changes: 1 addition & 14 deletions src/collections/configure/types/vectorizer.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,5 @@
import { VectorIndexConfigCreateType, VectorIndexConfigUpdateType } from './vectorIndex.js';
import {
Img2VecNeuralConfig,
ModuleConfig,
Multi2VecBindConfig,
Multi2VecClipConfig,
Multi2VecPalmConfig,
Ref2VecCentroidConfig,
Text2VecAWSConfig,
Text2VecAzureOpenAIConfig,
Text2VecCohereConfig,
VectorIndexType,
Vectorizer,
VectorizerConfigType,
} from '../../config/types/index.js';
import { ModuleConfig, VectorIndexType, Vectorizer, VectorizerConfigType } from '../../config/types/index.js';
import { PrimitiveKeys } from '../../types/internal.js';

export type VectorizerCreateOptions<P, I, V> = {
Expand Down
Loading
Loading