feat: update docs

aiosumma/aiosumma/proto/index_service_pb2.pyi

@@ -18,9 +18,6 @@ class ConflictStrategy(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
 class Compression(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     __slots__ = []
     None: _ClassVar[Compression]
-    Brotli: _ClassVar[Compression]
-    Lz4: _ClassVar[Compression]
-    Snappy: _ClassVar[Compression]
     Zstd: _ClassVar[Compression]
     Zstd7: _ClassVar[Compression]
     Zstd9: _ClassVar[Compression]
@@ -32,9 +29,6 @@ OVERWRITE_ALWAYS: ConflictStrategy
 OVERWRITE: ConflictStrategy
 MERGE: ConflictStrategy
 None: Compression
-Brotli: Compression
-Lz4: Compression
-Snappy: Compression
 Zstd: Compression
 Zstd7: Compression
 Zstd9: Compression

aiosumma/aiosumma/proto/public_service_pb2.pyi

@@ -0,0 +1,5 @@
+import query_pb2 as _query_pb2
+from google.protobuf import descriptor as _descriptor
+from typing import ClassVar as _ClassVar
+
+DESCRIPTOR: _descriptor.FileDescriptor

aiosumma/aiosumma/proto/public_service_pb2_grpc.py

@@ -0,0 +1,70 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from . import query_pb2 as query__pb2
+
+
+class PublicApiStub(object):
+    """Searches documents in the stored indices
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.search = channel.unary_unary(
+                '/summa.proto.PublicApi/search',
+                request_serializer=query__pb2.SearchRequest.SerializeToString,
+                response_deserializer=query__pb2.SearchResponse.FromString,
+                )
+
+
+class PublicApiServicer(object):
+    """Searches documents in the stored indices
+    """
+
+    def search(self, request, context):
+        """Make search in Summa
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_PublicApiServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'search': grpc.unary_unary_rpc_method_handler(
+                    servicer.search,
+                    request_deserializer=query__pb2.SearchRequest.FromString,
+                    response_serializer=query__pb2.SearchResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'summa.proto.PublicApi', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class PublicApi(object):
+    """Searches documents in the stored indices
+    """
+
+    @staticmethod
+    def search(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/summa.proto.PublicApi/search',
+            query__pb2.SearchRequest.SerializeToString,
+            query__pb2.SearchResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

aiosumma/aiosumma/proto/query_pb2.pyi

@@ -56,7 +56,7 @@ class MorphologyConfig(_message.Message):
     def __init__(self, derive_tenses_coefficient: _Optional[float] = ...) -> None: ...
 
 class QueryParserConfig(_message.Message):
-    __slots__ = ["field_aliases", "field_boosts", "term_field_mapper_configs", "term_limit", "default_fields", "boolean_should_mode", "disjuction_max_mode", "exact_matches_promoter", "removed_fields", "morphology_configs", "query_language"]
+    __slots__ = ["field_aliases", "field_boosts", "term_field_mapper_configs", "term_limit", "default_fields", "boolean_should_mode", "disjuction_max_mode", "exact_matches_promoter", "excluded_fields", "morphology_configs", "query_language"]
     class FieldAliasesEntry(_message.Message):
         __slots__ = ["key", "value"]
         KEY_FIELD_NUMBER: _ClassVar[int]
@@ -93,7 +93,7 @@ class QueryParserConfig(_message.Message):
     BOOLEAN_SHOULD_MODE_FIELD_NUMBER: _ClassVar[int]
     DISJUCTION_MAX_MODE_FIELD_NUMBER: _ClassVar[int]
     EXACT_MATCHES_PROMOTER_FIELD_NUMBER: _ClassVar[int]
-    REMOVED_FIELDS_FIELD_NUMBER: _ClassVar[int]
+    EXCLUDED_FIELDS_FIELD_NUMBER: _ClassVar[int]
     MORPHOLOGY_CONFIGS_FIELD_NUMBER: _ClassVar[int]
     QUERY_LANGUAGE_FIELD_NUMBER: _ClassVar[int]
     field_aliases: _containers.ScalarMap[str, str]
@@ -104,10 +104,26 @@ class QueryParserConfig(_message.Message):
     boolean_should_mode: MatchQueryBooleanShouldMode
     disjuction_max_mode: MatchQueryDisjuctionMaxMode
     exact_matches_promoter: ExactMatchesPromoter
-    removed_fields: _containers.RepeatedScalarFieldContainer[str]
+    excluded_fields: _containers.RepeatedScalarFieldContainer[str]
     morphology_configs: _containers.MessageMap[str, MorphologyConfig]
     query_language: str
-    def __init__(self, field_aliases: _Optional[_Mapping[str, str]] = ..., field_boosts: _Optional[_Mapping[str, float]] = ..., term_field_mapper_configs: _Optional[_Mapping[str, TermFieldMapperConfig]] = ..., term_limit: _Optional[int] = ..., default_fields: _Optional[_Iterable[str]] = ..., boolean_should_mode: _Optional[_Union[MatchQueryBooleanShouldMode, _Mapping]] = ..., disjuction_max_mode: _Optional[_Union[MatchQueryDisjuctionMaxMode, _Mapping]] = ..., exact_matches_promoter: _Optional[_Union[ExactMatchesPromoter, _Mapping]] = ..., removed_fields: _Optional[_Iterable[str]] = ..., morphology_configs: _Optional[_Mapping[str, MorphologyConfig]] = ..., query_language: _Optional[str] = ...) -> None: ...
+    def __init__(self, field_aliases: _Optional[_Mapping[str, str]] = ..., field_boosts: _Optional[_Mapping[str, float]] = ..., term_field_mapper_configs: _Optional[_Mapping[str, TermFieldMapperConfig]] = ..., term_limit: _Optional[int] = ..., default_fields: _Optional[_Iterable[str]] = ..., boolean_should_mode: _Optional[_Union[MatchQueryBooleanShouldMode, _Mapping]] = ..., disjuction_max_mode: _Optional[_Union[MatchQueryDisjuctionMaxMode, _Mapping]] = ..., exact_matches_promoter: _Optional[_Union[ExactMatchesPromoter, _Mapping]] = ..., excluded_fields: _Optional[_Iterable[str]] = ..., morphology_configs: _Optional[_Mapping[str, MorphologyConfig]] = ..., query_language: _Optional[str] = ...) -> None: ...
+
+class SearchRequest(_message.Message):
+    __slots__ = ["index_alias", "query", "collectors", "is_fieldnorms_scoring_enabled", "load_cache", "store_cache"]
+    INDEX_ALIAS_FIELD_NUMBER: _ClassVar[int]
+    QUERY_FIELD_NUMBER: _ClassVar[int]
+    COLLECTORS_FIELD_NUMBER: _ClassVar[int]
+    IS_FIELDNORMS_SCORING_ENABLED_FIELD_NUMBER: _ClassVar[int]
+    LOAD_CACHE_FIELD_NUMBER: _ClassVar[int]
+    STORE_CACHE_FIELD_NUMBER: _ClassVar[int]
+    index_alias: str
+    query: Query
+    collectors: _containers.RepeatedCompositeFieldContainer[Collector]
+    is_fieldnorms_scoring_enabled: bool
+    load_cache: bool
+    store_cache: bool
+    def __init__(self, index_alias: _Optional[str] = ..., query: _Optional[_Union[Query, _Mapping]] = ..., collectors: _Optional[_Iterable[_Union[Collector, _Mapping]]] = ..., is_fieldnorms_scoring_enabled: bool = ..., load_cache: bool = ..., store_cache: bool = ...) -> None: ...
 
 class SearchResponse(_message.Message):
     __slots__ = ["elapsed_secs", "collector_outputs"]
@@ -377,12 +393,14 @@ class FacetCollectorOutput(_message.Message):
     def __init__(self, facet_counts: _Optional[_Mapping[str, int]] = ...) -> None: ...
 
 class ReservoirSamplingCollector(_message.Message):
-    __slots__ = ["limit", "fields"]
+    __slots__ = ["limit", "fields", "excluded_fields"]
     LIMIT_FIELD_NUMBER: _ClassVar[int]
     FIELDS_FIELD_NUMBER: _ClassVar[int]
+    EXCLUDED_FIELDS_FIELD_NUMBER: _ClassVar[int]
     limit: int
     fields: _containers.RepeatedScalarFieldContainer[str]
-    def __init__(self, limit: _Optional[int] = ..., fields: _Optional[_Iterable[str]] = ...) -> None: ...
+    excluded_fields: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, limit: _Optional[int] = ..., fields: _Optional[_Iterable[str]] = ..., excluded_fields: _Optional[_Iterable[str]] = ...) -> None: ...
 
 class RandomDocument(_message.Message):
     __slots__ = ["document", "score", "index_alias"]
@@ -401,7 +419,7 @@ class ReservoirSamplingCollectorOutput(_message.Message):
     def __init__(self, documents: _Optional[_Iterable[_Union[RandomDocument, _Mapping]]] = ...) -> None: ...
 
 class TopDocsCollector(_message.Message):
-    __slots__ = ["limit", "offset", "scorer", "snippet_configs", "explain", "fields"]
+    __slots__ = ["limit", "offset", "scorer", "snippet_configs", "explain", "fields", "excluded_fields"]
     class SnippetConfigsEntry(_message.Message):
         __slots__ = ["key", "value"]
         KEY_FIELD_NUMBER: _ClassVar[int]
@@ -415,13 +433,15 @@ class TopDocsCollector(_message.Message):
     SNIPPET_CONFIGS_FIELD_NUMBER: _ClassVar[int]
     EXPLAIN_FIELD_NUMBER: _ClassVar[int]
     FIELDS_FIELD_NUMBER: _ClassVar[int]
+    EXCLUDED_FIELDS_FIELD_NUMBER: _ClassVar[int]
     limit: int
     offset: int
     scorer: Scorer
     snippet_configs: _containers.ScalarMap[str, int]
     explain: bool
     fields: _containers.RepeatedScalarFieldContainer[str]
-    def __init__(self, limit: _Optional[int] = ..., offset: _Optional[int] = ..., scorer: _Optional[_Union[Scorer, _Mapping]] = ..., snippet_configs: _Optional[_Mapping[str, int]] = ..., explain: bool = ..., fields: _Optional[_Iterable[str]] = ...) -> None: ...
+    excluded_fields: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, limit: _Optional[int] = ..., offset: _Optional[int] = ..., scorer: _Optional[_Union[Scorer, _Mapping]] = ..., snippet_configs: _Optional[_Mapping[str, int]] = ..., explain: bool = ..., fields: _Optional[_Iterable[str]] = ..., excluded_fields: _Optional[_Iterable[str]] = ...) -> None: ...
 
 class DocumentsCollectorOutput(_message.Message):
     __slots__ = ["scored_documents", "has_next"]

aiosumma/aiosumma/proto/search_service_pb2.pyi

@@ -1,23 +1,5 @@
 import query_pb2 as _query_pb2
-from google.protobuf.internal import containers as _containers
 from google.protobuf import descriptor as _descriptor
-from google.protobuf import message as _message
-from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+from typing import ClassVar as _ClassVar
 
 DESCRIPTOR: _descriptor.FileDescriptor
-
-class SearchRequest(_message.Message):
-    __slots__ = ["index_alias", "query", "collectors", "is_fieldnorms_scoring_enabled", "load_cache", "store_cache"]
-    INDEX_ALIAS_FIELD_NUMBER: _ClassVar[int]
-    QUERY_FIELD_NUMBER: _ClassVar[int]
-    COLLECTORS_FIELD_NUMBER: _ClassVar[int]
-    IS_FIELDNORMS_SCORING_ENABLED_FIELD_NUMBER: _ClassVar[int]
-    LOAD_CACHE_FIELD_NUMBER: _ClassVar[int]
-    STORE_CACHE_FIELD_NUMBER: _ClassVar[int]
-    index_alias: str
-    query: _query_pb2.Query
-    collectors: _containers.RepeatedCompositeFieldContainer[_query_pb2.Collector]
-    is_fieldnorms_scoring_enabled: bool
-    load_cache: bool
-    store_cache: bool
-    def __init__(self, index_alias: _Optional[str] = ..., query: _Optional[_Union[_query_pb2.Query, _Mapping]] = ..., collectors: _Optional[_Iterable[_Union[_query_pb2.Collector, _Mapping]]] = ..., is_fieldnorms_scoring_enabled: bool = ..., load_cache: bool = ..., store_cache: bool = ...) -> None: ...

aiosumma/aiosumma/proto/search_service_pb2_grpc.py

@@ -3,7 +3,6 @@
 import grpc
 
 from . import query_pb2 as query__pb2
-from . import search_service_pb2 as search__service__pb2
 
 
 class SearchApiStub(object):
@@ -18,7 +17,7 @@ def __init__(self, channel):
         """
         self.search = channel.unary_unary(
                 '/summa.proto.SearchApi/search',
-                request_serializer=search__service__pb2.SearchRequest.SerializeToString,
+                request_serializer=query__pb2.SearchRequest.SerializeToString,
                 response_deserializer=query__pb2.SearchResponse.FromString,
                 )
 
@@ -39,7 +38,7 @@ def add_SearchApiServicer_to_server(servicer, server):
     rpc_method_handlers = {
             'search': grpc.unary_unary_rpc_method_handler(
                     servicer.search,
-                    request_deserializer=search__service__pb2.SearchRequest.FromString,
+                    request_deserializer=query__pb2.SearchRequest.FromString,
                     response_serializer=query__pb2.SearchResponse.SerializeToString,
             ),
     }
@@ -65,7 +64,7 @@ def search(request,
             timeout=None,
             metadata=None):
         return grpc.experimental.unary_unary(request, target, '/summa.proto.SearchApi/search',
-            search__service__pb2.SearchRequest.SerializeToString,
+            query__pb2.SearchRequest.SerializeToString,
             query__pb2.SearchResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

aiosumma/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aiosumma"
-version = "2.47.1"
+version = "2.47.2"
 authors = [{ name = "Pasha Podolsky", email = "ppodolsky@me.com" }]
 description = "Async client for Summa Search"
 readme = "README.md"