Package com.sap.ai.sdk.grounding.model
Class RetrievalVectorSearchFilter
java.lang.Object
com.sap.ai.sdk.grounding.model.RetrievalVectorSearchFilter
RetrievalVectorSearchFilter
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for RetrievalVectorSearchFilter. -
Method Summary
Modifier and TypeMethodDescriptionaddChunkMetadataItem(RetrievalKeyValueListPair chunkMetadataItem) Add one chunkMetadata instance to thisRetrievalVectorSearchFilter.addDataRepositoriesItem(String dataRepositoriesItem) Add one dataRepositories instance to thisRetrievalVectorSearchFilter.addDataRepositoryMetadataItem(RetrievalKeyValueListPair dataRepositoryMetadataItem) Add one dataRepositoryMetadata instance to thisRetrievalVectorSearchFilter.addDocumentMetadataItem(RetrievalSearchDocumentKeyValueListPair documentMetadataItem) Add one documentMetadata instance to thisRetrievalVectorSearchFilter.chunkMetadata(List<RetrievalKeyValueListPair> chunkMetadata) Set the chunkMetadata of thisRetrievalVectorSearchFilterinstance and return the same instance.create()Create a type-safe, fluent-api builder object to construct a newRetrievalVectorSearchFilterinstance with all required arguments.dataRepositories(List<String> dataRepositories) Set the dataRepositories of thisRetrievalVectorSearchFilterinstance and return the same instance.dataRepositoryMetadata(List<RetrievalKeyValueListPair> dataRepositoryMetadata) Set the dataRepositoryMetadata of thisRetrievalVectorSearchFilterinstance and return the same instance.dataRepositoryType(DataRepositoryType dataRepositoryType) Set the dataRepositoryType of thisRetrievalVectorSearchFilterinstance and return the same instance.documentMetadata(List<RetrievalSearchDocumentKeyValueListPair> documentMetadata) Set the documentMetadata of thisRetrievalVectorSearchFilterinstance and return the same instance.booleanSet the filter of thisRetrievalVectorSearchFilterinstance and return the same instance.Restrict chunks considered during search to those with the given metadata.getCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theRetrievalVectorSearchFilter.Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.Restrict DataRepositories considered during search to those annotated with the given metadata.Get dataRepositoryTypeRestrict documents considered during search to those annotated with the given metadata.Get filtergetId()Identifier of this RetrievalSearchFilter - unique per request.Destination Name of remote instance.Get scoringConfigurationGet searchConfigurationinthashCode()Set the id of thisRetrievalVectorSearchFilterinstance and return the same instance.remoteName(String remoteName) Set the remoteName of thisRetrievalVectorSearchFilterinstance and return the same instance.scoringConfiguration(VectorScoringConfiguration scoringConfiguration) Set the scoringConfiguration of thisRetrievalVectorSearchFilterinstance and return the same instance.searchConfiguration(RetrievalSearchConfiguration searchConfiguration) Set the searchConfiguration of thisRetrievalVectorSearchFilterinstance and return the same instance.voidsetChunkMetadata(List<RetrievalKeyValueListPair> chunkMetadata) Set the chunkMetadata of thisRetrievalVectorSearchFilterinstance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisRetrievalVectorSearchFilterinstance.voidsetDataRepositories(List<String> dataRepositories) Set the dataRepositories of thisRetrievalVectorSearchFilterinstance.voidsetDataRepositoryMetadata(List<RetrievalKeyValueListPair> dataRepositoryMetadata) Set the dataRepositoryMetadata of thisRetrievalVectorSearchFilterinstance.voidsetDataRepositoryType(DataRepositoryType dataRepositoryType) Set the dataRepositoryType of thisRetrievalVectorSearchFilterinstance.voidsetDocumentMetadata(List<RetrievalSearchDocumentKeyValueListPair> documentMetadata) Set the documentMetadata of thisRetrievalVectorSearchFilterinstance.voidSet the filter of thisRetrievalVectorSearchFilterinstance.voidSet the id of thisRetrievalVectorSearchFilterinstance.voidsetRemoteName(String remoteName) Set the remoteName of thisRetrievalVectorSearchFilterinstance.voidsetScoringConfiguration(VectorScoringConfiguration scoringConfiguration) Set the scoringConfiguration of thisRetrievalVectorSearchFilterinstance.voidsetSearchConfiguration(RetrievalSearchConfiguration searchConfiguration) Set the searchConfiguration of thisRetrievalVectorSearchFilterinstance.toMap()Get the value of all properties of thisRetrievalVectorSearchFilterinstance including unrecognized properties.toString()
-
Constructor Details
-
RetrievalVectorSearchFilter
protected RetrievalVectorSearchFilter()Default constructor for RetrievalVectorSearchFilter.
-
-
Method Details
-
id
Set the id of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
id- Identifier of this RetrievalSearchFilter - unique per request.- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
getId
Identifier of this RetrievalSearchFilter - unique per request.- Returns:
- id The id of this
RetrievalVectorSearchFilterinstance.
-
setId
Set the id of thisRetrievalVectorSearchFilterinstance.- Parameters:
id- Identifier of this RetrievalSearchFilter - unique per request.
-
searchConfiguration
@Nonnull public RetrievalVectorSearchFilter searchConfiguration(@Nullable RetrievalSearchConfiguration searchConfiguration) Set the searchConfiguration of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
searchConfiguration- The searchConfiguration of thisRetrievalVectorSearchFilter- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
getSearchConfiguration
Get searchConfiguration- Returns:
- searchConfiguration The searchConfiguration of this
RetrievalVectorSearchFilterinstance.
-
setSearchConfiguration
Set the searchConfiguration of thisRetrievalVectorSearchFilterinstance.- Parameters:
searchConfiguration- The searchConfiguration of thisRetrievalVectorSearchFilter
-
dataRepositories
@Nonnull public RetrievalVectorSearchFilter dataRepositories(@Nullable List<String> dataRepositories) Set the dataRepositories of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
dataRepositories- Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
addDataRepositoriesItem
@Nonnull public RetrievalVectorSearchFilter addDataRepositoriesItem(@Nonnull String dataRepositoriesItem) Add one dataRepositories instance to thisRetrievalVectorSearchFilter.- Parameters:
dataRepositoriesItem- The dataRepositories that should be added- Returns:
- The same instance of type
RetrievalVectorSearchFilter
-
getDataRepositories
Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.- Returns:
- dataRepositories The dataRepositories of this
RetrievalVectorSearchFilterinstance.
-
setDataRepositories
Set the dataRepositories of thisRetrievalVectorSearchFilterinstance.- Parameters:
dataRepositories- Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids.
-
dataRepositoryType
@Nonnull public RetrievalVectorSearchFilter dataRepositoryType(@Nullable DataRepositoryType dataRepositoryType) Set the dataRepositoryType of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
dataRepositoryType- The dataRepositoryType of thisRetrievalVectorSearchFilter- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
getDataRepositoryType
Get dataRepositoryType- Returns:
- dataRepositoryType The dataRepositoryType of this
RetrievalVectorSearchFilterinstance.
-
setDataRepositoryType
Set the dataRepositoryType of thisRetrievalVectorSearchFilterinstance.- Parameters:
dataRepositoryType- The dataRepositoryType of thisRetrievalVectorSearchFilter
-
remoteName
Set the remoteName of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
remoteName- Destination Name of remote instance.- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
getRemoteName
Destination Name of remote instance.- Returns:
- remoteName The remoteName of this
RetrievalVectorSearchFilterinstance.
-
setRemoteName
Set the remoteName of thisRetrievalVectorSearchFilterinstance.- Parameters:
remoteName- Destination Name of remote instance.
-
dataRepositoryMetadata
@Nonnull public RetrievalVectorSearchFilter dataRepositoryMetadata(@Nullable List<RetrievalKeyValueListPair> dataRepositoryMetadata) Set the dataRepositoryMetadata of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
dataRepositoryMetadata- Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
addDataRepositoryMetadataItem
@Nonnull public RetrievalVectorSearchFilter addDataRepositoryMetadataItem(@Nonnull RetrievalKeyValueListPair dataRepositoryMetadataItem) Add one dataRepositoryMetadata instance to thisRetrievalVectorSearchFilter.- Parameters:
dataRepositoryMetadataItem- The dataRepositoryMetadata that should be added- Returns:
- The same instance of type
RetrievalVectorSearchFilter
-
getDataRepositoryMetadata
Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']- Returns:
- dataRepositoryMetadata The dataRepositoryMetadata of this
RetrievalVectorSearchFilterinstance.
-
setDataRepositoryMetadata
public void setDataRepositoryMetadata(@Nullable List<RetrievalKeyValueListPair> dataRepositoryMetadata) Set the dataRepositoryMetadata of thisRetrievalVectorSearchFilterinstance.- Parameters:
dataRepositoryMetadata- Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']
-
documentMetadata
@Nonnull public RetrievalVectorSearchFilter documentMetadata(@Nullable List<RetrievalSearchDocumentKeyValueListPair> documentMetadata) Set the documentMetadata of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
documentMetadata- Restrict documents considered during search to those annotated with the given metadata.- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
addDocumentMetadataItem
@Nonnull public RetrievalVectorSearchFilter addDocumentMetadataItem(@Nonnull RetrievalSearchDocumentKeyValueListPair documentMetadataItem) Add one documentMetadata instance to thisRetrievalVectorSearchFilter.- Parameters:
documentMetadataItem- The documentMetadata that should be added- Returns:
- The same instance of type
RetrievalVectorSearchFilter
-
getDocumentMetadata
Restrict documents considered during search to those annotated with the given metadata.- Returns:
- documentMetadata The documentMetadata of this
RetrievalVectorSearchFilterinstance.
-
setDocumentMetadata
public void setDocumentMetadata(@Nullable List<RetrievalSearchDocumentKeyValueListPair> documentMetadata) Set the documentMetadata of thisRetrievalVectorSearchFilterinstance.- Parameters:
documentMetadata- Restrict documents considered during search to those annotated with the given metadata.
-
chunkMetadata
@Nonnull public RetrievalVectorSearchFilter chunkMetadata(@Nullable List<RetrievalKeyValueListPair> chunkMetadata) Set the chunkMetadata of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
chunkMetadata- Restrict chunks considered during search to those with the given metadata.- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
addChunkMetadataItem
@Nonnull public RetrievalVectorSearchFilter addChunkMetadataItem(@Nonnull RetrievalKeyValueListPair chunkMetadataItem) Add one chunkMetadata instance to thisRetrievalVectorSearchFilter.- Parameters:
chunkMetadataItem- The chunkMetadata that should be added- Returns:
- The same instance of type
RetrievalVectorSearchFilter
-
getChunkMetadata
Restrict chunks considered during search to those with the given metadata.- Returns:
- chunkMetadata The chunkMetadata of this
RetrievalVectorSearchFilterinstance.
-
setChunkMetadata
Set the chunkMetadata of thisRetrievalVectorSearchFilterinstance.- Parameters:
chunkMetadata- Restrict chunks considered during search to those with the given metadata.
-
filter
@Nonnull public RetrievalVectorSearchFilter filter(@Nullable RetrievalVectorSearchFilterFilter filter) Set the filter of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
filter- The filter of thisRetrievalVectorSearchFilter- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
getFilter
Get filter- Returns:
- filter The filter of this
RetrievalVectorSearchFilterinstance.
-
setFilter
Set the filter of thisRetrievalVectorSearchFilterinstance.- Parameters:
filter- The filter of thisRetrievalVectorSearchFilter
-
scoringConfiguration
@Nonnull public RetrievalVectorSearchFilter scoringConfiguration(@Nullable VectorScoringConfiguration scoringConfiguration) Set the scoringConfiguration of thisRetrievalVectorSearchFilterinstance and return the same instance.- Parameters:
scoringConfiguration- The scoringConfiguration of thisRetrievalVectorSearchFilter- Returns:
- The same instance of this
RetrievalVectorSearchFilterclass
-
getScoringConfiguration
Get scoringConfiguration- Returns:
- scoringConfiguration The scoringConfiguration of this
RetrievalVectorSearchFilterinstance.
-
setScoringConfiguration
Set the scoringConfiguration of thisRetrievalVectorSearchFilterinstance.- Parameters:
scoringConfiguration- The scoringConfiguration of thisRetrievalVectorSearchFilter
-
getCustomFieldNames
Get the names of the unrecognizable properties of theRetrievalVectorSearchFilter.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisRetrievalVectorSearchFilterinstance.- Parameters:
name- The name of the property- Returns:
- The value of the property
- Throws:
NoSuchElementException- If no property with the given name could be found.
-
toMap
Get the value of all properties of thisRetrievalVectorSearchFilterinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisRetrievalVectorSearchFilterinstance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.- Parameters:
customFieldName- The name of the propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a type-safe, fluent-api builder object to construct a newRetrievalVectorSearchFilterinstance with all required arguments.
-
toMap()instead.