docs(api): reworded descriptions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-0768ad934de95835e9f317b06cbe79b8958d9acc9b4b06f3c7743a2b9fcc0f44.yml
-openapi_spec_hash: e00200876d755684db6ee666119bc719
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-a307f2351504c7d4d18a52c3cc7a120f2b1347bb5cfd8f89f8a95591bcc22eac.yml
+openapi_spec_hash: 5057bbce3b8a5c9561253624702d893d
 config_hash: 9040e7359f066240ad536041fb2c5185

src/isaacus/_client.py

@@ -98,7 +98,7 @@ def __init__(
 
     @cached_property
     def embeddings(self) -> EmbeddingsResource:
-        """Embed legal texts with Isaacus legal AI embedders."""
+        """Vectorize content with an Isaacus embedding model."""
         from .resources.embeddings import EmbeddingsResource
 
         return EmbeddingsResource(self)
@@ -112,7 +112,7 @@ def classifications(self) -> ClassificationsResource:
     @cached_property
     def rerankings(self) -> RerankingsResource:
         """
-        Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
+        Score and rank documents by their relevance to queries with an Isaacus reranker.
         """
         from .resources.rerankings import RerankingsResource
 
@@ -126,6 +126,7 @@ def extractions(self) -> ExtractionsResource:
 
     @cached_property
     def enrichments(self) -> EnrichmentsResource:
+        """Enrich documents with an Isaacus enrichment model."""
         from .resources.enrichments import EnrichmentsResource
 
         return EnrichmentsResource(self)
@@ -300,7 +301,7 @@ def __init__(
 
     @cached_property
     def embeddings(self) -> AsyncEmbeddingsResource:
-        """Embed legal texts with Isaacus legal AI embedders."""
+        """Vectorize content with an Isaacus embedding model."""
         from .resources.embeddings import AsyncEmbeddingsResource
 
         return AsyncEmbeddingsResource(self)
@@ -314,7 +315,7 @@ def classifications(self) -> AsyncClassificationsResource:
     @cached_property
     def rerankings(self) -> AsyncRerankingsResource:
         """
-        Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
+        Score and rank documents by their relevance to queries with an Isaacus reranker.
         """
         from .resources.rerankings import AsyncRerankingsResource
 
@@ -328,6 +329,7 @@ def extractions(self) -> AsyncExtractionsResource:
 
     @cached_property
     def enrichments(self) -> AsyncEnrichmentsResource:
+        """Enrich documents with an Isaacus enrichment model."""
         from .resources.enrichments import AsyncEnrichmentsResource
 
         return AsyncEnrichmentsResource(self)
@@ -453,7 +455,7 @@ def __init__(self, client: Isaacus) -> None:
 
     @cached_property
     def embeddings(self) -> embeddings.EmbeddingsResourceWithRawResponse:
-        """Embed legal texts with Isaacus legal AI embedders."""
+        """Vectorize content with an Isaacus embedding model."""
         from .resources.embeddings import EmbeddingsResourceWithRawResponse
 
         return EmbeddingsResourceWithRawResponse(self._client.embeddings)
@@ -467,7 +469,7 @@ def classifications(self) -> classifications.ClassificationsResourceWithRawRespo
     @cached_property
     def rerankings(self) -> rerankings.RerankingsResourceWithRawResponse:
         """
-        Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
+        Score and rank documents by their relevance to queries with an Isaacus reranker.
         """
         from .resources.rerankings import RerankingsResourceWithRawResponse
 
@@ -481,6 +483,7 @@ def extractions(self) -> extractions.ExtractionsResourceWithRawResponse:
 
     @cached_property
     def enrichments(self) -> enrichments.EnrichmentsResourceWithRawResponse:
+        """Enrich documents with an Isaacus enrichment model."""
         from .resources.enrichments import EnrichmentsResourceWithRawResponse
 
         return EnrichmentsResourceWithRawResponse(self._client.enrichments)
@@ -494,7 +497,7 @@ def __init__(self, client: AsyncIsaacus) -> None:
 
     @cached_property
     def embeddings(self) -> embeddings.AsyncEmbeddingsResourceWithRawResponse:
-        """Embed legal texts with Isaacus legal AI embedders."""
+        """Vectorize content with an Isaacus embedding model."""
         from .resources.embeddings import AsyncEmbeddingsResourceWithRawResponse
 
         return AsyncEmbeddingsResourceWithRawResponse(self._client.embeddings)
@@ -508,7 +511,7 @@ def classifications(self) -> classifications.AsyncClassificationsResourceWithRaw
     @cached_property
     def rerankings(self) -> rerankings.AsyncRerankingsResourceWithRawResponse:
         """
-        Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
+        Score and rank documents by their relevance to queries with an Isaacus reranker.
         """
         from .resources.rerankings import AsyncRerankingsResourceWithRawResponse
 
@@ -522,6 +525,7 @@ def extractions(self) -> extractions.AsyncExtractionsResourceWithRawResponse:
 
     @cached_property
     def enrichments(self) -> enrichments.AsyncEnrichmentsResourceWithRawResponse:
+        """Enrich documents with an Isaacus enrichment model."""
         from .resources.enrichments import AsyncEnrichmentsResourceWithRawResponse
 
         return AsyncEnrichmentsResourceWithRawResponse(self._client.enrichments)
@@ -535,7 +539,7 @@ def __init__(self, client: Isaacus) -> None:
 
     @cached_property
     def embeddings(self) -> embeddings.EmbeddingsResourceWithStreamingResponse:
-        """Embed legal texts with Isaacus legal AI embedders."""
+        """Vectorize content with an Isaacus embedding model."""
         from .resources.embeddings import EmbeddingsResourceWithStreamingResponse
 
         return EmbeddingsResourceWithStreamingResponse(self._client.embeddings)
@@ -549,7 +553,7 @@ def classifications(self) -> classifications.ClassificationsResourceWithStreamin
     @cached_property
     def rerankings(self) -> rerankings.RerankingsResourceWithStreamingResponse:
         """
-        Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
+        Score and rank documents by their relevance to queries with an Isaacus reranker.
         """
         from .resources.rerankings import RerankingsResourceWithStreamingResponse
 
@@ -563,6 +567,7 @@ def extractions(self) -> extractions.ExtractionsResourceWithStreamingResponse:
 
     @cached_property
     def enrichments(self) -> enrichments.EnrichmentsResourceWithStreamingResponse:
+        """Enrich documents with an Isaacus enrichment model."""
         from .resources.enrichments import EnrichmentsResourceWithStreamingResponse
 
         return EnrichmentsResourceWithStreamingResponse(self._client.enrichments)
@@ -576,7 +581,7 @@ def __init__(self, client: AsyncIsaacus) -> None:
 
     @cached_property
     def embeddings(self) -> embeddings.AsyncEmbeddingsResourceWithStreamingResponse:
-        """Embed legal texts with Isaacus legal AI embedders."""
+        """Vectorize content with an Isaacus embedding model."""
         from .resources.embeddings import AsyncEmbeddingsResourceWithStreamingResponse
 
         return AsyncEmbeddingsResourceWithStreamingResponse(self._client.embeddings)
@@ -590,7 +595,7 @@ def classifications(self) -> classifications.AsyncClassificationsResourceWithStr
     @cached_property
     def rerankings(self) -> rerankings.AsyncRerankingsResourceWithStreamingResponse:
         """
-        Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
+        Score and rank documents by their relevance to queries with an Isaacus reranker.
         """
         from .resources.rerankings import AsyncRerankingsResourceWithStreamingResponse
 
@@ -604,6 +609,7 @@ def extractions(self) -> extractions.AsyncExtractionsResourceWithStreamingRespon
 
     @cached_property
     def enrichments(self) -> enrichments.AsyncEnrichmentsResourceWithStreamingResponse:
+        """Enrich documents with an Isaacus enrichment model."""
         from .resources.enrichments import AsyncEnrichmentsResourceWithStreamingResponse
 
         return AsyncEnrichmentsResourceWithStreamingResponse(self._client.enrichments)

src/isaacus/resources/classifications/classifications.py

@@ -19,7 +19,7 @@
 class ClassificationsResource(SyncAPIResource):
     @cached_property
     def universal(self) -> UniversalResource:
-        """Classify legal documents with Isaacus legal AI classifiers."""
+        """Classify documents with an Isaacus classification model."""
         return UniversalResource(self._client)
 
     @cached_property
@@ -45,7 +45,7 @@ def with_streaming_response(self) -> ClassificationsResourceWithStreamingRespons
 class AsyncClassificationsResource(AsyncAPIResource):
     @cached_property
     def universal(self) -> AsyncUniversalResource:
-        """Classify legal documents with Isaacus legal AI classifiers."""
+        """Classify documents with an Isaacus classification model."""
         return AsyncUniversalResource(self._client)
 
     @cached_property
@@ -74,7 +74,7 @@ def __init__(self, classifications: ClassificationsResource) -> None:
 
     @cached_property
     def universal(self) -> UniversalResourceWithRawResponse:
-        """Classify legal documents with Isaacus legal AI classifiers."""
+        """Classify documents with an Isaacus classification model."""
         return UniversalResourceWithRawResponse(self._classifications.universal)
 
 
@@ -84,7 +84,7 @@ def __init__(self, classifications: AsyncClassificationsResource) -> None:
 
     @cached_property
     def universal(self) -> AsyncUniversalResourceWithRawResponse:
-        """Classify legal documents with Isaacus legal AI classifiers."""
+        """Classify documents with an Isaacus classification model."""
         return AsyncUniversalResourceWithRawResponse(self._classifications.universal)
 
 
@@ -94,7 +94,7 @@ def __init__(self, classifications: ClassificationsResource) -> None:
 
     @cached_property
     def universal(self) -> UniversalResourceWithStreamingResponse:
-        """Classify legal documents with Isaacus legal AI classifiers."""
+        """Classify documents with an Isaacus classification model."""
         return UniversalResourceWithStreamingResponse(self._classifications.universal)
 
 
@@ -104,5 +104,5 @@ def __init__(self, classifications: AsyncClassificationsResource) -> None:
 
     @cached_property
     def universal(self) -> AsyncUniversalResourceWithStreamingResponse:
-        """Classify legal documents with Isaacus legal AI classifiers."""
+        """Classify documents with an Isaacus classification model."""
         return AsyncUniversalResourceWithStreamingResponse(self._classifications.universal)

src/isaacus/resources/classifications/universal/universal.py

@@ -25,7 +25,7 @@
 
 
 class UniversalResource(SyncAPIResource):
-    """Classify legal documents with Isaacus legal AI classifiers."""
+    """Classify documents with an Isaacus classification model."""
 
     @cached_property
     def with_raw_response(self) -> UniversalResourceWithRawResponse:
@@ -63,8 +63,7 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> UniversalClassificationResponse:
         """
-        Classify the relevance of legal documents to a query with an Isaacus universal
-        legal AI classifier.
+        Classify documents with an Isaacus universal classification model.
 
         Args:
           model: The ID of the [model](https://docs.isaacus.com/models#universal-classification)
@@ -128,7 +127,7 @@ def create(
 
 
 class AsyncUniversalResource(AsyncAPIResource):
-    """Classify legal documents with Isaacus legal AI classifiers."""
+    """Classify documents with an Isaacus classification model."""
 
     @cached_property
     def with_raw_response(self) -> AsyncUniversalResourceWithRawResponse:
@@ -166,8 +165,7 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> UniversalClassificationResponse:
         """
-        Classify the relevance of legal documents to a query with an Isaacus universal
-        legal AI classifier.
+        Classify documents with an Isaacus universal classification model.
 
         Args:
           model: The ID of the [model](https://docs.isaacus.com/models#universal-classification)

src/isaacus/resources/embeddings.py

@@ -25,7 +25,7 @@
 
 
 class EmbeddingsResource(SyncAPIResource):
-    """Embed legal texts with Isaacus legal AI embedders."""
+    """Vectorize content with an Isaacus embedding model."""
 
     @cached_property
     def with_raw_response(self) -> EmbeddingsResourceWithRawResponse:
@@ -62,7 +62,7 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> EmbeddingResponse:
         """
-        Embed legal texts with an Isaacus legal AI embedder.
+        Vectorize content with an Isaacus embedding model.
 
         Args:
           model: The ID of the [model](https://docs.isaacus.com/models#embedding) to use for
@@ -120,7 +120,7 @@ def create(
 
 
 class AsyncEmbeddingsResource(AsyncAPIResource):
-    """Embed legal texts with Isaacus legal AI embedders."""
+    """Vectorize content with an Isaacus embedding model."""
 
     @cached_property
     def with_raw_response(self) -> AsyncEmbeddingsResourceWithRawResponse:
@@ -157,7 +157,7 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> EmbeddingResponse:
         """
-        Embed legal texts with an Isaacus legal AI embedder.
+        Vectorize content with an Isaacus embedding model.
 
         Args:
           model: The ID of the [model](https://docs.isaacus.com/models#embedding) to use for

src/isaacus/resources/enrichments.py

@@ -25,6 +25,8 @@
 
 
 class EnrichmentsResource(SyncAPIResource):
+    """Enrich documents with an Isaacus enrichment model."""
+
     @cached_property
     def with_raw_response(self) -> EnrichmentsResourceWithRawResponse:
         """
@@ -58,7 +60,7 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> EnrichmentResponse:
         """
-        Enrich documents with an Isaacus enricher model.
+        Enrich documents with an Isaacus enrichment model.
 
         Args:
           model: The ID of the [model](https://docs.isaacus.com/models#enrichment) to use for
@@ -113,6 +115,8 @@ def create(
 
 
 class AsyncEnrichmentsResource(AsyncAPIResource):
+    """Enrich documents with an Isaacus enrichment model."""
+
     @cached_property
     def with_raw_response(self) -> AsyncEnrichmentsResourceWithRawResponse:
         """
@@ -146,7 +150,7 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> EnrichmentResponse:
         """
-        Enrich documents with an Isaacus enricher model.
+        Enrich documents with an Isaacus enrichment model.
 
         Args:
           model: The ID of the [model](https://docs.isaacus.com/models#enrichment) to use for

src/isaacus/resources/extractions/extractions.py

@@ -19,7 +19,7 @@
 class ExtractionsResource(SyncAPIResource):
     @cached_property
     def qa(self) -> QAResource:
-        """Extract information from legal documents with Isaacus legal AI extractors."""
+        """Extract information from documents with an Isaacus extraction model."""
         return QAResource(self._client)
 
     @cached_property
@@ -45,7 +45,7 @@ def with_streaming_response(self) -> ExtractionsResourceWithStreamingResponse:
 class AsyncExtractionsResource(AsyncAPIResource):
     @cached_property
     def qa(self) -> AsyncQAResource:
-        """Extract information from legal documents with Isaacus legal AI extractors."""
+        """Extract information from documents with an Isaacus extraction model."""
         return AsyncQAResource(self._client)
 
     @cached_property
@@ -74,7 +74,7 @@ def __init__(self, extractions: ExtractionsResource) -> None:
 
     @cached_property
     def qa(self) -> QAResourceWithRawResponse:
-        """Extract information from legal documents with Isaacus legal AI extractors."""
+        """Extract information from documents with an Isaacus extraction model."""
         return QAResourceWithRawResponse(self._extractions.qa)
 
 
@@ -84,7 +84,7 @@ def __init__(self, extractions: AsyncExtractionsResource) -> None:
 
     @cached_property
     def qa(self) -> AsyncQAResourceWithRawResponse:
-        """Extract information from legal documents with Isaacus legal AI extractors."""
+        """Extract information from documents with an Isaacus extraction model."""
         return AsyncQAResourceWithRawResponse(self._extractions.qa)
 
 
@@ -94,7 +94,7 @@ def __init__(self, extractions: ExtractionsResource) -> None:
 
     @cached_property
     def qa(self) -> QAResourceWithStreamingResponse:
-        """Extract information from legal documents with Isaacus legal AI extractors."""
+        """Extract information from documents with an Isaacus extraction model."""
         return QAResourceWithStreamingResponse(self._extractions.qa)
 
 
@@ -104,5 +104,5 @@ def __init__(self, extractions: AsyncExtractionsResource) -> None:
 
     @cached_property
     def qa(self) -> AsyncQAResourceWithStreamingResponse:
-        """Extract information from legal documents with Isaacus legal AI extractors."""
+        """Extract information from documents with an Isaacus extraction model."""
         return AsyncQAResourceWithStreamingResponse(self._extractions.qa)