@codesoul-co/hypha-memory / profile-contract

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/profile-contract.ts
• Exports: 39

Using this module

Use the Profile contract module for declaring and runtime-validating contracts. It exports 34 constants, 5 functions.

Import from the package entrypoint

import {
  embeddingProviderSpecDefinition,
  embeddingProviderSpecExample,
  embeddingProviderSpecSchema,
  memoryConflictPolicySpecSchema,
  memoryConsolidationPolicySpecSchema,
  memoryContractJsonSchemas,
  memoryContractSpecDefinitions,
  memoryContractSpecRefJsonSchema,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

• The module exposes 5 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 34 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { embeddingProviderSpecSchema } from '@codesoul-co/hypha-memory';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = embeddingProviderSpecSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
embeddingProviderSpecDefinition	constant	const embeddingProviderSpecDefinition: SpecSchemaDefinition<EmbeddingProviderSpec>	Runtime validation entrypoint for the Embedding Provider spec, combining its parser, example and JSON Schema.
embeddingProviderSpecExample	constant	const embeddingProviderSpecExample: EmbeddingProviderSpec	Valid example value for Embedding Provider Spec.
embeddingProviderSpecSchema	constant	const embeddingProviderSpecSchema: z.ZodType<EmbeddingProviderSpec, z.ZodTypeDef, EmbeddingProviderSpec>	Runtime schema for Embedding Provider Spec.
memoryConflictPolicySpecSchema	constant	const memoryConflictPolicySpecSchema: z.ZodType<MemoryConflictPolicySpec, z.ZodTypeDef, MemoryConflictPolicySpec>	Runtime schema for Memory Conflict Policy Spec.
memoryConsolidationPolicySpecSchema	constant	const memoryConsolidationPolicySpecSchema: z.ZodType<MemoryConsolidationPolicySpec, z.ZodTypeDef, MemoryConsolidationPolicySpec>	Runtime schema for Memory Consolidation Policy Spec.
memoryContractJsonSchemas	constant	const memoryContractJsonSchemas: Record<string, JsonSchema>	Memory Contract JSON Schemas constant exported by the profile-contract module.
memoryContractSpecDefinitions	constant	const memoryContractSpecDefinitions: readonly [SpecSchemaDefinition<MemoryProfileSpec>, SpecSchemaDefinition<MemoryManagementProviderSpec>, SpecSchemaDefinition<WorkingMemoryStoreSpec>, SpecSchemaDefinition<MemoryRecordStoreSpec>, SpecSchemaDefinition<VectorStoreSpec>, SpecSchemaDefinition<EmbeddingProviderSpec>]	Memory Contract Spec Definitions constant exported by the profile-contract module.
memoryContractSpecRefJsonSchema	constant	const memoryContractSpecRefJsonSchema: JsonSchema	JSON Schema for Memory Contract Spec Ref.
memoryContractSpecRefSchema	constant	const memoryContractSpecRefSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; } & { revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>	Runtime schema for Memory Contract Spec Ref.
memoryFallbackPolicySpecSchema	constant	const memoryFallbackPolicySpecSchema: z.ZodType<MemoryFallbackPolicySpec, z.ZodTypeDef, MemoryFallbackPolicySpec>	Runtime schema for Memory Fallback Policy Spec.
memoryIndexingPolicySpecSchema	constant	const memoryIndexingPolicySpecSchema: z.ZodType<MemoryIndexingPolicySpec, z.ZodTypeDef, MemoryIndexingPolicySpec>	Runtime schema for Memory Indexing Policy Spec.
memoryManagementCapabilitiesSchema	constant	const memoryManagementCapabilitiesSchema: z.ZodType<MemoryManagementCapabilities, z.ZodTypeDef, MemoryManagementCapabilities>	Runtime schema for Memory Management Capabilities.
memoryManagementProviderSpecDefinition	constant	const memoryManagementProviderSpecDefinition: SpecSchemaDefinition<MemoryManagementProviderSpec>	Runtime validation entrypoint for the Memory Management Provider spec, combining its parser, example and JSON Schema.
memoryManagementProviderSpecExample	constant	const memoryManagementProviderSpecExample: MemoryManagementProviderSpec	Valid example value for Memory Management Provider Spec.
memoryManagementProviderSpecSchema	constant	const memoryManagementProviderSpecSchema: z.ZodType<MemoryManagementProviderSpec, z.ZodTypeDef, MemoryManagementProviderSpec>	Runtime schema for Memory Management Provider Spec.
memoryPrivacyPolicySpecSchema	constant	const memoryPrivacyPolicySpecSchema: z.ZodType<MemoryPrivacyPolicySpec, z.ZodTypeDef, MemoryPrivacyPolicySpec>	Runtime schema for Memory Privacy Policy Spec.
memoryProfileSpecDefinition	constant	const memoryProfileSpecDefinition: SpecSchemaDefinition<MemoryProfileSpec>	Runtime validation entrypoint for the Memory Profile spec, combining its parser, example and JSON Schema.
memoryProfileSpecExample	constant	const memoryProfileSpecExample: MemoryProfileSpec	Valid example value for Memory Profile Spec.
memoryProfileSpecJsonSchema	constant	const memoryProfileSpecJsonSchema: JsonSchema	JSON Schema for Memory Profile Spec.
memoryProfileSpecSchema	constant	const memoryProfileSpecSchema: z.ZodType<MemoryProfileSpec, z.ZodTypeDef, MemoryProfileSpec>	Runtime schema for Memory Profile Spec.
memoryRecordStoreSpecDefinition	constant	const memoryRecordStoreSpecDefinition: SpecSchemaDefinition<MemoryRecordStoreSpec>	Runtime validation entrypoint for the Memory Record Store spec, combining its parser, example and JSON Schema.
memoryRecordStoreSpecExample	constant	const memoryRecordStoreSpecExample: MemoryRecordStoreSpec	Valid example value for Memory Record Store Spec.
memoryRecordStoreSpecSchema	constant	const memoryRecordStoreSpecSchema: z.ZodType<MemoryRecordStoreSpec, z.ZodTypeDef, MemoryRecordStoreSpec>	Runtime schema for Memory Record Store Spec.
memoryRetentionPolicySpecSchema	constant	const memoryRetentionPolicySpecSchema: z.ZodType<MemoryRetentionPolicySpec, z.ZodTypeDef, MemoryRetentionPolicySpec>	Runtime schema for Memory Retention Policy Spec.
memoryRetrievalPolicySpecSchema	constant	const memoryRetrievalPolicySpecSchema: z.ZodType<MemoryRetrievalPolicySpec, z.ZodTypeDef, MemoryRetrievalPolicySpec>	Runtime schema for Memory Retrieval Policy Spec.
memoryScopePolicySpecSchema	constant	const memoryScopePolicySpecSchema: z.ZodType<MemoryScopePolicySpec, z.ZodTypeDef, MemoryScopePolicySpec>	Runtime schema for Memory Scope Policy Spec.
memoryWritePolicySpecSchema	constant	const memoryWritePolicySpecSchema: z.ZodType<MemoryWritePolicySpec, z.ZodTypeDef, MemoryWritePolicySpec>	Runtime schema for Memory Write Policy Spec.
vectorStoreCapabilitiesSchema	constant	const vectorStoreCapabilitiesSchema: z.ZodType<VectorStoreCapabilities, z.ZodTypeDef, VectorStoreCapabilities>	Runtime schema for Vector Store Capabilities.
vectorStoreSpecDefinition	constant	const vectorStoreSpecDefinition: SpecSchemaDefinition<VectorStoreSpec>	Runtime validation entrypoint for the Vector Store spec, combining its parser, example and JSON Schema.
vectorStoreSpecExample	constant	const vectorStoreSpecExample: VectorStoreSpec	Valid example value for Vector Store Spec.
vectorStoreSpecSchema	constant	const vectorStoreSpecSchema: z.ZodType<VectorStoreSpec, z.ZodTypeDef, VectorStoreSpec>	Runtime schema for Vector Store Spec.
workingMemoryStoreSpecDefinition	constant	const workingMemoryStoreSpecDefinition: SpecSchemaDefinition<WorkingMemoryStoreSpec>	Runtime validation entrypoint for the Working Memory Store spec, combining its parser, example and JSON Schema.
workingMemoryStoreSpecExample	constant	const workingMemoryStoreSpecExample: WorkingMemoryStoreSpec	Valid example value for Working Memory Store Spec.
workingMemoryStoreSpecSchema	constant	const workingMemoryStoreSpecSchema: z.ZodType<WorkingMemoryStoreSpec, z.ZodTypeDef, WorkingMemoryStoreSpec>	Runtime schema for Working Memory Store Spec.
validateEmbeddingProviderSpec	function	validateEmbeddingProviderSpec(input: unknown): EmbeddingProviderSpec	Validate Embedding Provider Spec function with 1 public call signature; parameters and return types are listed below.
validateMemoryProfileSpec	function	validateMemoryProfileSpec(input: unknown): MemoryProfileSpec	Validate Memory Profile Spec function with 1 public call signature; parameters and return types are listed below.
validateMemoryRecordStoreSpec	function	validateMemoryRecordStoreSpec(input: unknown): MemoryRecordStoreSpec	Validate Memory Record Store Spec function with 1 public call signature; parameters and return types are listed below.
validateVectorStoreSpec	function	validateVectorStoreSpec(input: unknown): VectorStoreSpec	Validate Vector Store Spec function with 1 public call signature; parameters and return types are listed below.
validateWorkingMemoryStoreSpec	function	validateWorkingMemoryStoreSpec(input: unknown): WorkingMemoryStoreSpec	Validate Working Memory Store Spec function with 1 public call signature; parameters and return types are listed below.

embeddingProviderSpecDefinition

Runtime validation entrypoint for the Embedding Provider spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { embeddingProviderSpecDefinition } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const embeddingProviderSpecDefinition: SpecSchemaDefinition<EmbeddingProviderSpec>;

embeddingProviderSpecExample

Valid example value for Embedding Provider Spec.

• Kind: constant
• Import: import { embeddingProviderSpecExample } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const embeddingProviderSpecExample: EmbeddingProviderSpec;

embeddingProviderSpecSchema

Runtime schema for Embedding Provider Spec.

• Kind: constant
• Import: import { embeddingProviderSpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const embeddingProviderSpecSchema: z.ZodType<EmbeddingProviderSpec, z.ZodTypeDef, EmbeddingProviderSpec>;

memoryConflictPolicySpecSchema

Runtime schema for Memory Conflict Policy Spec.

• Kind: constant
• Import: import { memoryConflictPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryConflictPolicySpecSchema: z.ZodType<MemoryConflictPolicySpec, z.ZodTypeDef, MemoryConflictPolicySpec>;

memoryConsolidationPolicySpecSchema

Runtime schema for Memory Consolidation Policy Spec.

• Kind: constant
• Import: import { memoryConsolidationPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryConsolidationPolicySpecSchema: z.ZodType<MemoryConsolidationPolicySpec, z.ZodTypeDef, MemoryConsolidationPolicySpec>;

memoryContractJsonSchemas

Memory Contract JSON Schemas constant exported by the profile-contract module.

• Kind: constant
• Import: import { memoryContractJsonSchemas } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryContractJsonSchemas: Record<string, JsonSchema>;

memoryContractSpecDefinitions

Memory Contract Spec Definitions constant exported by the profile-contract module.

• Kind: constant
• Import: import { memoryContractSpecDefinitions } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryContractSpecDefinitions: readonly [SpecSchemaDefinition<MemoryProfileSpec>, SpecSchemaDefinition<MemoryManagementProviderSpec>, SpecSchemaDefinition<WorkingMemoryStoreSpec>, SpecSchemaDefinition<MemoryRecordStoreSpec>, SpecSchemaDefinition<VectorStoreSpec>, SpecSchemaDefinition<EmbeddingProviderSpec>];

memoryContractSpecRefJsonSchema

JSON Schema for Memory Contract Spec Ref.

• Kind: constant
• Import: import { memoryContractSpecRefJsonSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryContractSpecRefJsonSchema: JsonSchema;

memoryContractSpecRefSchema

Runtime schema for Memory Contract Spec Ref.

• Kind: constant
• Import: import { memoryContractSpecRefSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryContractSpecRefSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; } & { revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>;

memoryFallbackPolicySpecSchema

Runtime schema for Memory Fallback Policy Spec.

• Kind: constant
• Import: import { memoryFallbackPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryFallbackPolicySpecSchema: z.ZodType<MemoryFallbackPolicySpec, z.ZodTypeDef, MemoryFallbackPolicySpec>;

memoryIndexingPolicySpecSchema

Runtime schema for Memory Indexing Policy Spec.

• Kind: constant
• Import: import { memoryIndexingPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryIndexingPolicySpecSchema: z.ZodType<MemoryIndexingPolicySpec, z.ZodTypeDef, MemoryIndexingPolicySpec>;

memoryManagementCapabilitiesSchema

Runtime schema for Memory Management Capabilities.

• Kind: constant
• Import: import { memoryManagementCapabilitiesSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryManagementCapabilitiesSchema: z.ZodType<MemoryManagementCapabilities, z.ZodTypeDef, MemoryManagementCapabilities>;

memoryManagementProviderSpecDefinition

Runtime validation entrypoint for the Memory Management Provider spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { memoryManagementProviderSpecDefinition } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryManagementProviderSpecDefinition: SpecSchemaDefinition<MemoryManagementProviderSpec>;

memoryManagementProviderSpecExample

Valid example value for Memory Management Provider Spec.

• Kind: constant
• Import: import { memoryManagementProviderSpecExample } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryManagementProviderSpecExample: MemoryManagementProviderSpec;

memoryManagementProviderSpecSchema

Runtime schema for Memory Management Provider Spec.

• Kind: constant
• Import: import { memoryManagementProviderSpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryManagementProviderSpecSchema: z.ZodType<MemoryManagementProviderSpec, z.ZodTypeDef, MemoryManagementProviderSpec>;

memoryPrivacyPolicySpecSchema

Runtime schema for Memory Privacy Policy Spec.

• Kind: constant
• Import: import { memoryPrivacyPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryPrivacyPolicySpecSchema: z.ZodType<MemoryPrivacyPolicySpec, z.ZodTypeDef, MemoryPrivacyPolicySpec>;

memoryProfileSpecDefinition

Runtime validation entrypoint for the Memory Profile spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { memoryProfileSpecDefinition } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryProfileSpecDefinition: SpecSchemaDefinition<MemoryProfileSpec>;

memoryProfileSpecExample

Valid example value for Memory Profile Spec.

• Kind: constant
• Import: import { memoryProfileSpecExample } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryProfileSpecExample: MemoryProfileSpec;

memoryProfileSpecJsonSchema

JSON Schema for Memory Profile Spec.

• Kind: constant
• Import: import { memoryProfileSpecJsonSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryProfileSpecJsonSchema: JsonSchema;

memoryProfileSpecSchema

Runtime schema for Memory Profile Spec.

• Kind: constant
• Import: import { memoryProfileSpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryProfileSpecSchema: z.ZodType<MemoryProfileSpec, z.ZodTypeDef, MemoryProfileSpec>;

memoryRecordStoreSpecDefinition

Runtime validation entrypoint for the Memory Record Store spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { memoryRecordStoreSpecDefinition } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryRecordStoreSpecDefinition: SpecSchemaDefinition<MemoryRecordStoreSpec>;

memoryRecordStoreSpecExample

Valid example value for Memory Record Store Spec.

• Kind: constant
• Import: import { memoryRecordStoreSpecExample } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryRecordStoreSpecExample: MemoryRecordStoreSpec;

memoryRecordStoreSpecSchema

Runtime schema for Memory Record Store Spec.

• Kind: constant
• Import: import { memoryRecordStoreSpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryRecordStoreSpecSchema: z.ZodType<MemoryRecordStoreSpec, z.ZodTypeDef, MemoryRecordStoreSpec>;

memoryRetentionPolicySpecSchema

Runtime schema for Memory Retention Policy Spec.

• Kind: constant
• Import: import { memoryRetentionPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryRetentionPolicySpecSchema: z.ZodType<MemoryRetentionPolicySpec, z.ZodTypeDef, MemoryRetentionPolicySpec>;

memoryRetrievalPolicySpecSchema

Runtime schema for Memory Retrieval Policy Spec.

• Kind: constant
• Import: import { memoryRetrievalPolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryRetrievalPolicySpecSchema: z.ZodType<MemoryRetrievalPolicySpec, z.ZodTypeDef, MemoryRetrievalPolicySpec>;

memoryScopePolicySpecSchema

Runtime schema for Memory Scope Policy Spec.

• Kind: constant
• Import: import { memoryScopePolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryScopePolicySpecSchema: z.ZodType<MemoryScopePolicySpec, z.ZodTypeDef, MemoryScopePolicySpec>;

memoryWritePolicySpecSchema

Runtime schema for Memory Write Policy Spec.

• Kind: constant
• Import: import { memoryWritePolicySpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const memoryWritePolicySpecSchema: z.ZodType<MemoryWritePolicySpec, z.ZodTypeDef, MemoryWritePolicySpec>;

vectorStoreCapabilitiesSchema

Runtime schema for Vector Store Capabilities.

• Kind: constant
• Import: import { vectorStoreCapabilitiesSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const vectorStoreCapabilitiesSchema: z.ZodType<VectorStoreCapabilities, z.ZodTypeDef, VectorStoreCapabilities>;

vectorStoreSpecDefinition

Runtime validation entrypoint for the Vector Store spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { vectorStoreSpecDefinition } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const vectorStoreSpecDefinition: SpecSchemaDefinition<VectorStoreSpec>;

vectorStoreSpecExample

Valid example value for Vector Store Spec.

• Kind: constant
• Import: import { vectorStoreSpecExample } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const vectorStoreSpecExample: VectorStoreSpec;

vectorStoreSpecSchema

Runtime schema for Vector Store Spec.

• Kind: constant
• Import: import { vectorStoreSpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const vectorStoreSpecSchema: z.ZodType<VectorStoreSpec, z.ZodTypeDef, VectorStoreSpec>;

workingMemoryStoreSpecDefinition

Runtime validation entrypoint for the Working Memory Store spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { workingMemoryStoreSpecDefinition } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const workingMemoryStoreSpecDefinition: SpecSchemaDefinition<WorkingMemoryStoreSpec>;

workingMemoryStoreSpecExample

Valid example value for Working Memory Store Spec.

• Kind: constant
• Import: import { workingMemoryStoreSpecExample } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const workingMemoryStoreSpecExample: WorkingMemoryStoreSpec;

workingMemoryStoreSpecSchema

Runtime schema for Working Memory Store Spec.

• Kind: constant
• Import: import { workingMemoryStoreSpecSchema } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare const workingMemoryStoreSpecSchema: z.ZodType<WorkingMemoryStoreSpec, z.ZodTypeDef, WorkingMemoryStoreSpec>;

validateEmbeddingProviderSpec

Validate Embedding Provider Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateEmbeddingProviderSpec } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare function validateEmbeddingProviderSpec(input: unknown): EmbeddingProviderSpec;

Call signature

validateEmbeddingProviderSpec(input: unknown): EmbeddingProviderSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: EmbeddingProviderSpec
• Description: The return contract is defined by the type shown above.

validateMemoryProfileSpec

Validate Memory Profile Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryProfileSpec } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare function validateMemoryProfileSpec(input: unknown): MemoryProfileSpec;

Call signature

validateMemoryProfileSpec(input: unknown): MemoryProfileSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryProfileSpec
• Description: The return contract is defined by the type shown above.

validateMemoryRecordStoreSpec

Validate Memory Record Store Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryRecordStoreSpec } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare function validateMemoryRecordStoreSpec(input: unknown): MemoryRecordStoreSpec;

Call signature

validateMemoryRecordStoreSpec(input: unknown): MemoryRecordStoreSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryRecordStoreSpec
• Description: The return contract is defined by the type shown above.

validateVectorStoreSpec

Validate Vector Store Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateVectorStoreSpec } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare function validateVectorStoreSpec(input: unknown): VectorStoreSpec;

Call signature

validateVectorStoreSpec(input: unknown): VectorStoreSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: VectorStoreSpec
• Description: The return contract is defined by the type shown above.

validateWorkingMemoryStoreSpec

Validate Working Memory Store Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateWorkingMemoryStoreSpec } from '@codesoul-co/hypha-memory';
• Source module: profile-contract

Declaration

export declare function validateWorkingMemoryStoreSpec(input: unknown): WorkingMemoryStoreSpec;

Call signature

validateWorkingMemoryStoreSpec(input: unknown): WorkingMemoryStoreSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: WorkingMemoryStoreSpec
• Description: The return contract is defined by the type shown above.