Releases: Aleph-Alpha/intelligence-layer-sdk
Releases · Aleph-Alpha/intelligence-layer-sdk
v12.0.1
v12.0.0
Breaking Changes
StudioClientraisesValueErrorwhen instantiated with project name that belongs to multiple projects.
Full Changelog: v11.0.0...v12.0.0
v11.0.0
11.0.0
Breaking Changes
QdrantInMemoryRetrieverandHybridQdrantInMemoryRetrievernow usepharia-1-embedding-4608-controlas embedding model with an embedding size of 4608.
Full Changelog: v10.0.0...v11.0.0
v10.0.0
10.0.0
Features
- Introduced
AsyncDocumentIndexClientandAsyncDocumentIndexRetrieveras drop-in replacements for their blocking counterparts, enabling coroutine-based, non-blocking document indexing and retrieval.
Fixes
InMemoryDatasetRepositorynow has a more descriptive error message when creating a dataset fails due to an ID clash.StudioClientnow deserializes and serializes examples while maintaining type information, which was previously dropped.RunRepositoryandEvaluationRepositorynow more accurately reflect their actual return types in their signatures. Previously, it was not obvious that failed examples could be returned.FileTracer.tracesnow uses "utf-8" encoding to read the persisted trace file. Previously, the machines default encoding was used, which could lead to a mismatch between the encoding used for writing and reading.
Breaking Changes
StudioClientnow handles project_id as a string instead of an integer. This is only relevant when you handle project ids (not names) manually.InMemoryDatasetRepositorynow returns the exact types given by users when retrievingExample. Previously, it disregarded the types it was given and returned what was saved.- This is in line with how the other repositories work.
InMemoryDatasetRepository,InMemoryRunRepository,InMemoryEvaluationRepository, andInMemoryAggregationRepositorynow either return the exact types given by users when retrieving example-related data or fail. Specifically, this means that passing the wrong type when retrieving data will now fail with aValidationError. Previously, the repositories disregarded the types they were given and returned whatever object was saved.- This is in line with how the other repositories work.
EloQaEvaluationLogicnow has an expected output type ofNoneinstead ofSingleChunkQaOutput. The information was unused.- If you have pipelines that define data to be processed by this logic, or if you subclass from this specific logic, you may need to adapt it.
log_probsin theCompletionInputof thedo_runmethod been set to 20 instead of the prior value of 30
- The legacy
Trace Viewerhas now been removed along with all references to it.
Full changelog: v9.1.0...v10.0.0
v9.1.0
9.1.0
Features
- New Pharia Kernel connector (
KernelTask) for calling Skills from a Task - Add
HybridQdrantInMemoryRetrieverenabling hybrid search for in-memory Qdrant collections
Fixes
- Add warning to
PromptBasedClassifyandPromptBasedClassifyWithDefinitionsto be cautious when using them with model families other than luminous
Full changelog: v9.0.2...v9.1.0
v9.0.2
v9.0.1
9.0.1
Fixes
- Fixes an incompatibility where models with tokenizer with no whitespace prefix could not be used for qa examples. Now, no error will be thrown.
Full changelog: v9.0.0...v9.0.1
v9.0.0
9.0.0
Features
- Introduce
BenchmarkandStudioBenchmarkBenchmarkallows you to evaluate and compare the performance of differentTasks with a fixed evaluation logic, aggregation logic andDataset.- Add
how_to_execute_a_benchmark.ipynbto how-tos - Add
studio.ipynbto notebooks to show how one can debug aTaskwith Studio
- Introduce
BenchmarkRepositoryandStudioBenchmarkRepository - Add
create_projectbool toStudioClient.__init__()to enable users to automatically create their Studio projects - Add progressbar to the
Runnerto be able to track theRun - Add
StudioClient.submit_benchmark_lineagesfunction and include it inStudioClient.submit_benchmark_execution
DocumentIndexClient
- Add method
DocumentIndexClient.chunks()for retrieving all text chunks of a document. - Add metadata filter
FilterOps.IS_NULL, that allows to filter fields based on whether their value is null.
Fixes
- The Document Index
SearchQuerynow correctly allows searches with a negativemin_score.
Deprecations
...
Breaking Changes
- The env variable
POSTGRES_HOSTis split intoPOSTGRES_HOSTandPOSTGRES_PORT. This affects all classes interacting with Studio and theInstructionFinetuningDataRepository. - The following env variables now need to be set (previously pointed to defaults)
CLIENT_URL- URL of your inference stackDOCUMENT_INDEX_URL- URL of the document index
Full changelog: v8.0.0...v9.0.0
v8.0.0
v8.0.0
Features
- You can now customise the embedding model when creating an index using the
DocumentIndexClient. - You can now use the
InstructableEmbedembedding strategy when creating an index using theDocumentIndexClient. See thedocument_index.ipynbnotebook for more information and an example.
Breaking Changes
- The way you configure indexes in the
DocumentIndexClienthas changed. See thedocument_index.ipynbnotebook for more information. - The
EmbeddingTypealias has been renamed toRepresentationto better align with the underlying API. - The
embedding_typefield has been removed from theIndexConfigurationclass. You now configure embedding-related parameters via theembeddingfield. - You now always need to specify an embedding model when creating an index. Previously, this was always
luminous-base.