@sap-ai-sdk/document-grounding
Version:
> [!warning] > This package is still in **beta** and is subject to breaking changes. Use it with caution.
38 lines • 1.46 kB
TypeScript
import type { SearchConfiguration } from './search-configuration.js';
import type { DataRepositoryType } from './data-repository-type.js';
import type { KeyValueListPair } from './key-value-list-pair.js';
import type { SearchDocumentKeyValueListPair } from './search-document-key-value-list-pair.js';
/**
* Limit scope of search to certain DataRepositories, Documents or Chunks.
*/
export type RetrievalSearchFilter = {
/**
* Identifier of this SearchFilter - unique per request.
*/
id: string;
searchConfiguration?: SearchConfiguration;
/**
* Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.
* Default: [
* "*"
* ].
*/
dataRepositories?: string[];
dataRepositoryType: DataRepositoryType;
/**
* Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']
* Default: [].
*/
dataRepositoryMetadata?: KeyValueListPair[];
/**
* Restrict documents considered during search to those annotated with the given metadata.
* Default: [].
*/
documentMetadata?: SearchDocumentKeyValueListPair[];
/**
* Restrict chunks considered during search to those with the given metadata.
* Default: [].
*/
chunkMetadata?: KeyValueListPair[];
} & Record<string, any>;
//# sourceMappingURL=retrieval-search-filter.d.ts.map