diff --git a/sdk/search/azure-search-documents/CHANGELOG.md b/sdk/search/azure-search-documents/CHANGELOG.md index c542c2aaf61b..a94101ac2cfa 100644 --- a/sdk/search/azure-search-documents/CHANGELOG.md +++ b/sdk/search/azure-search-documents/CHANGELOG.md @@ -1,5 +1,23 @@ # Release History +## 12.1.0 (Unreleased) + +### Features Added + +- Added the following knowledge base activity record models for detailed retrieval activity tracking: + - `azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityArguments` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityRecord` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeActivityArguments` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeActivityRecord` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexActivityArguments` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexActivityRecord` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityArguments` + - `azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityRecord` + +### Other Changes + +- Removed `DebugInfo` model (empty in this API version; no longer part of the public API surface) + ## 12.0.0 (2026-04-01) ### Features Added diff --git a/sdk/search/azure-search-documents/apiview-properties.json b/sdk/search/azure-search-documents/apiview-properties.json index 30e0289a20c5..7ee2cc264e75 100644 --- a/sdk/search/azure-search-documents/apiview-properties.json +++ b/sdk/search/azure-search-documents/apiview-properties.json @@ -108,6 +108,8 @@ "azure.search.documents.indexes.models.KnowledgeBase": "Search.KnowledgeBase", "azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord": "Search.KnowledgeBaseActivityRecord", "azure.search.documents.knowledgebases.models.KnowledgeBaseAgenticReasoningActivityRecord": "Search.KnowledgeBaseAgenticReasoningActivityRecord", + "azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityArguments": "Search.KnowledgeBaseAzureBlobActivityArguments", + "azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityRecord": "Search.KnowledgeBaseAzureBlobActivityRecord", "azure.search.documents.knowledgebases.models.KnowledgeBaseReference": "Search.KnowledgeBaseReference", "azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobReference": "Search.KnowledgeBaseAzureBlobReference", "azure.search.documents.indexes.models.KnowledgeBaseModel": "Search.KnowledgeBaseModel", @@ -115,6 +117,8 @@ "azure.search.documents.knowledgebases.models.KnowledgeBaseErrorAdditionalInfo": "Search.KnowledgeBaseErrorAdditionalInfo", "azure.search.documents.knowledgebases.models.KnowledgeBaseErrorDetail": "Search.KnowledgeBaseErrorDetail", "azure.search.documents.knowledgebases.models.KnowledgeBaseImageContent": "Search.KnowledgeBaseImageContent", + "azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeActivityArguments": "Search.KnowledgeBaseIndexedOneLakeActivityArguments", + "azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeActivityRecord": "Search.KnowledgeBaseIndexedOneLakeActivityRecord", "azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeReference": "Search.KnowledgeBaseIndexedOneLakeReference", "azure.search.documents.knowledgebases.models.KnowledgeBaseMessage": "Search.KnowledgeBaseMessage", "azure.search.documents.knowledgebases.models.KnowledgeBaseMessageContent": "Search.KnowledgeBaseMessageContent", @@ -123,7 +127,11 @@ "azure.search.documents.knowledgebases.models.KnowledgeBaseModelWebSummarizationActivityRecord": "Search.KnowledgeBaseModelWebSummarizationActivityRecord", "azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest": "Search.KnowledgeBaseRetrievalRequest", "azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalResponse": "Search.KnowledgeBaseRetrievalResponse", + "azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexActivityArguments": "Search.KnowledgeBaseSearchIndexActivityArguments", + "azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexActivityRecord": "Search.KnowledgeBaseSearchIndexActivityRecord", "azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexReference": "Search.KnowledgeBaseSearchIndexReference", + "azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityArguments": "Search.KnowledgeBaseWebActivityArguments", + "azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityRecord": "Search.KnowledgeBaseWebActivityRecord", "azure.search.documents.knowledgebases.models.KnowledgeBaseWebReference": "Search.KnowledgeBaseWebReference", "azure.search.documents.knowledgebases.models.KnowledgeRetrievalIntent": "Search.KnowledgeRetrievalIntent", "azure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffort": "Search.KnowledgeRetrievalReasoningEffort", diff --git a/sdk/search/azure-search-documents/azure/search/documents/_operations/_operations.py b/sdk/search/azure-search-documents/azure/search/documents/_operations/_operations.py index dbd5421f2a00..7b25415ffd7a 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_operations/_operations.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_operations/_operations.py @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from io import IOBase import json from typing import Any, Callable, IO, Optional, TypeVar, Union, overload diff --git a/sdk/search/azure-search-documents/azure/search/documents/_utils/model_base.py b/sdk/search/azure-search-documents/azure/search/documents/_utils/model_base.py index da7d731af565..db24930fdca9 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_utils/model_base.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_utils/model_base.py @@ -22,7 +22,7 @@ from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder import xml.etree.ElementTree as ET -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError @@ -600,7 +600,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: for rest_field in self._attr_to_rest_field.values() if rest_field._default is not _UNSET } - if args: # pylint: disable=too-many-nested-blocks + if args: if isinstance(args[0], ET.Element): dict_to_pass.update(self._init_from_xml(args[0])) else: @@ -710,7 +710,7 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") - return super().__new__(cls) # pylint: disable=no-value-for-parameter + return super().__new__(cls) def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: for base in cls.__bases__: diff --git a/sdk/search/azure-search-documents/azure/search/documents/_version.py b/sdk/search/azure-search-documents/azure/search/documents/_version.py index 22c33ec5bb72..d20c7234ba3a 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_version.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_version.py @@ -3,6 +3,6 @@ # Licensed under the MIT License. # ------------------------------------ -VERSION = "12.0.0" # type: str +VERSION = "12.1.0" # type: str SDK_MONIKER = "search-documents/{}".format(VERSION) # type: str diff --git a/sdk/search/azure-search-documents/azure/search/documents/aio/_operations/_operations.py b/sdk/search/azure-search-documents/azure/search/documents/aio/_operations/_operations.py index adf0bea3c777..176388eb8f40 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/aio/_operations/_operations.py +++ b/sdk/search/azure-search-documents/azure/search/documents/aio/_operations/_operations.py @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from io import IOBase import json from typing import Any, Callable, IO, Optional, TypeVar, Union, overload diff --git a/sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_operations.py b/sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_operations.py index 6d991dd232df..1661a0d9ff01 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_operations.py +++ b/sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_operations.py @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from io import IOBase import json from typing import Any, Callable, IO, Literal, Optional, TypeVar, Union, overload diff --git a/sdk/search/azure-search-documents/azure/search/documents/indexes/_utils/model_base.py b/sdk/search/azure-search-documents/azure/search/documents/indexes/_utils/model_base.py index da7d731af565..db24930fdca9 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/indexes/_utils/model_base.py +++ b/sdk/search/azure-search-documents/azure/search/documents/indexes/_utils/model_base.py @@ -22,7 +22,7 @@ from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder import xml.etree.ElementTree as ET -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError @@ -600,7 +600,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: for rest_field in self._attr_to_rest_field.values() if rest_field._default is not _UNSET } - if args: # pylint: disable=too-many-nested-blocks + if args: if isinstance(args[0], ET.Element): dict_to_pass.update(self._init_from_xml(args[0])) else: @@ -710,7 +710,7 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") - return super().__new__(cls) # pylint: disable=no-value-for-parameter + return super().__new__(cls) def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: for base in cls.__bases__: diff --git a/sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_operations.py b/sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_operations.py index 2283f5c07552..5d89708a9deb 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_operations.py +++ b/sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_operations.py @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from io import IOBase import json from typing import Any, Callable, IO, Literal, Optional, TypeVar, Union, overload diff --git a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_operations/_operations.py b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_operations/_operations.py index 539027df674a..1bb802b7cb52 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_operations/_operations.py +++ b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_operations/_operations.py @@ -5,7 +5,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from io import IOBase import json from typing import Any, Callable, IO, Optional, TypeVar, Union, overload diff --git a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_utils/model_base.py b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_utils/model_base.py index da7d731af565..db24930fdca9 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_utils/model_base.py +++ b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_utils/model_base.py @@ -22,7 +22,7 @@ from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder import xml.etree.ElementTree as ET -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError @@ -600,7 +600,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: for rest_field in self._attr_to_rest_field.values() if rest_field._default is not _UNSET } - if args: # pylint: disable=too-many-nested-blocks + if args: if isinstance(args[0], ET.Element): dict_to_pass.update(self._init_from_xml(args[0])) else: @@ -710,7 +710,7 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") - return super().__new__(cls) # pylint: disable=no-value-for-parameter + return super().__new__(cls) def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: for base in cls.__bases__: diff --git a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_operations/_operations.py b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_operations/_operations.py index db31fdc21cc7..344969414ee7 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_operations/_operations.py +++ b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_operations/_operations.py @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping # pylint: disable=import-error +from collections.abc import MutableMapping from io import IOBase import json from typing import Any, Callable, IO, Optional, TypeVar, Union, overload diff --git a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/__init__.py b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/__init__.py index 5f662e0ba6a5..b5ac0612a19b 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/__init__.py +++ b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/__init__.py @@ -20,10 +20,14 @@ IndexedOneLakeKnowledgeSourceParams, KnowledgeBaseActivityRecord, KnowledgeBaseAgenticReasoningActivityRecord, + KnowledgeBaseAzureBlobActivityArguments, + KnowledgeBaseAzureBlobActivityRecord, KnowledgeBaseAzureBlobReference, KnowledgeBaseErrorAdditionalInfo, KnowledgeBaseErrorDetail, KnowledgeBaseImageContent, + KnowledgeBaseIndexedOneLakeActivityArguments, + KnowledgeBaseIndexedOneLakeActivityRecord, KnowledgeBaseIndexedOneLakeReference, KnowledgeBaseMessage, KnowledgeBaseMessageContent, @@ -33,7 +37,11 @@ KnowledgeBaseReference, KnowledgeBaseRetrievalRequest, KnowledgeBaseRetrievalResponse, + KnowledgeBaseSearchIndexActivityArguments, + KnowledgeBaseSearchIndexActivityRecord, KnowledgeBaseSearchIndexReference, + KnowledgeBaseWebActivityArguments, + KnowledgeBaseWebActivityRecord, KnowledgeBaseWebReference, KnowledgeRetrievalIntent, KnowledgeRetrievalMinimalReasoningEffort, @@ -69,10 +77,14 @@ "IndexedOneLakeKnowledgeSourceParams", "KnowledgeBaseActivityRecord", "KnowledgeBaseAgenticReasoningActivityRecord", + "KnowledgeBaseAzureBlobActivityArguments", + "KnowledgeBaseAzureBlobActivityRecord", "KnowledgeBaseAzureBlobReference", "KnowledgeBaseErrorAdditionalInfo", "KnowledgeBaseErrorDetail", "KnowledgeBaseImageContent", + "KnowledgeBaseIndexedOneLakeActivityArguments", + "KnowledgeBaseIndexedOneLakeActivityRecord", "KnowledgeBaseIndexedOneLakeReference", "KnowledgeBaseMessage", "KnowledgeBaseMessageContent", @@ -82,7 +94,11 @@ "KnowledgeBaseReference", "KnowledgeBaseRetrievalRequest", "KnowledgeBaseRetrievalResponse", + "KnowledgeBaseSearchIndexActivityArguments", + "KnowledgeBaseSearchIndexActivityRecord", "KnowledgeBaseSearchIndexReference", + "KnowledgeBaseWebActivityArguments", + "KnowledgeBaseWebActivityRecord", "KnowledgeBaseWebReference", "KnowledgeRetrievalIntent", "KnowledgeRetrievalMinimalReasoningEffort", diff --git a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/_models.py b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/_models.py index e33e0af1bd1a..31b7562d5f08 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/_models.py +++ b/sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/_models.py @@ -278,7 +278,9 @@ class KnowledgeBaseActivityRecord(_Model): operations. You probably want to use the sub-classes and not this class directly. Known sub-classes are: - KnowledgeBaseAgenticReasoningActivityRecord, KnowledgeBaseModelWebSummarizationActivityRecord + KnowledgeBaseAgenticReasoningActivityRecord, KnowledgeBaseAzureBlobActivityRecord, + KnowledgeBaseIndexedOneLakeActivityRecord, KnowledgeBaseModelWebSummarizationActivityRecord, + KnowledgeBaseSearchIndexActivityRecord, KnowledgeBaseWebActivityRecord :ivar id: The ID of the activity record. Required. :vartype id: int @@ -383,6 +385,101 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.type = KnowledgeBaseActivityRecordType.AGENTIC_REASONING # type: ignore +class KnowledgeBaseAzureBlobActivityArguments(_Model): + """Represents the arguments the azure blob retrieval activity was run with. + + :ivar search: The search string used to query blob contents. + :vartype search: str + """ + + search: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The search string used to query blob contents.""" + + @overload + def __init__( + self, + *, + search: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class KnowledgeBaseAzureBlobActivityRecord(KnowledgeBaseActivityRecord, discriminator="azureBlob"): + """Represents a azure blob retrieval activity record. + + :ivar id: The ID of the activity record. Required. + :vartype id: int + :ivar elapsed_ms: The elapsed time in milliseconds for the retrieval activity. + :vartype elapsed_ms: int + :ivar error: The error detail explaining why the operation failed. This property is only + included when the activity does not succeed. + :vartype error: ~azure.search.documents.knowledgebases.models.KnowledgeBaseErrorDetail + :ivar knowledge_source_name: The knowledge source for the retrieval activity. + :vartype knowledge_source_name: str + :ivar query_time: The query time for this retrieval activity. + :vartype query_time: ~datetime.datetime + :ivar count: The count of documents retrieved that were sufficiently relevant to pass the + reranker threshold. + :vartype count: int + :ivar type: The discriminator value. Required. Azure Blob retrieval activity. + :vartype type: str or ~azure.search.documents.knowledgebases.models.AZURE_BLOB + :ivar azure_blob_arguments: The azure blob arguments for the retrieval activity. + :vartype azure_blob_arguments: + ~azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityArguments + """ + + knowledge_source_name: Optional[str] = rest_field( + name="knowledgeSourceName", visibility=["read", "create", "update", "delete", "query"] + ) + """The knowledge source for the retrieval activity.""" + query_time: Optional[datetime.datetime] = rest_field( + name="queryTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The query time for this retrieval activity.""" + count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The count of documents retrieved that were sufficiently relevant to pass the reranker + threshold.""" + type: Literal[KnowledgeBaseActivityRecordType.AZURE_BLOB] = rest_discriminator(name="type", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The discriminator value. Required. Azure Blob retrieval activity.""" + azure_blob_arguments: Optional["_models.KnowledgeBaseAzureBlobActivityArguments"] = rest_field( + name="azureBlobArguments", visibility=["read", "create", "update", "delete", "query"] + ) + """The azure blob arguments for the retrieval activity.""" + + @overload + def __init__( + self, + *, + id: int, # pylint: disable=redefined-builtin + elapsed_ms: Optional[int] = None, + error: Optional["_models.KnowledgeBaseErrorDetail"] = None, + knowledge_source_name: Optional[str] = None, + query_time: Optional[datetime.datetime] = None, + count: Optional[int] = None, + azure_blob_arguments: Optional["_models.KnowledgeBaseAzureBlobActivityArguments"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.type = KnowledgeBaseActivityRecordType.AZURE_BLOB # type: ignore + + class KnowledgeBaseReference(_Model): """Base type for references. @@ -560,6 +657,103 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) +class KnowledgeBaseIndexedOneLakeActivityArguments(_Model): # pylint: disable=name-too-long + """Represents the arguments the indexed OneLake retrieval activity was run with. + + :ivar search: The search string used to query indexed OneLake contents. + :vartype search: str + """ + + search: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The search string used to query indexed OneLake contents.""" + + @overload + def __init__( + self, + *, + search: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class KnowledgeBaseIndexedOneLakeActivityRecord( + KnowledgeBaseActivityRecord, discriminator="indexedOneLake" +): # pylint: disable=name-too-long + """Represents a indexed OneLake retrieval activity record. + + :ivar id: The ID of the activity record. Required. + :vartype id: int + :ivar elapsed_ms: The elapsed time in milliseconds for the retrieval activity. + :vartype elapsed_ms: int + :ivar error: The error detail explaining why the operation failed. This property is only + included when the activity does not succeed. + :vartype error: ~azure.search.documents.knowledgebases.models.KnowledgeBaseErrorDetail + :ivar knowledge_source_name: The knowledge source for the retrieval activity. + :vartype knowledge_source_name: str + :ivar query_time: The query time for this retrieval activity. + :vartype query_time: ~datetime.datetime + :ivar count: The count of documents retrieved that were sufficiently relevant to pass the + reranker threshold. + :vartype count: int + :ivar type: The discriminator value. Required. Indexed OneLake retrieval activity. + :vartype type: str or ~azure.search.documents.knowledgebases.models.INDEXED_ONELAKE + :ivar indexed_one_lake_arguments: The indexed OneLake arguments for the retrieval activity. + :vartype indexed_one_lake_arguments: + ~azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeActivityArguments + """ + + knowledge_source_name: Optional[str] = rest_field( + name="knowledgeSourceName", visibility=["read", "create", "update", "delete", "query"] + ) + """The knowledge source for the retrieval activity.""" + query_time: Optional[datetime.datetime] = rest_field( + name="queryTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The query time for this retrieval activity.""" + count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The count of documents retrieved that were sufficiently relevant to pass the reranker + threshold.""" + type: Literal[KnowledgeBaseActivityRecordType.INDEXED_ONELAKE] = rest_discriminator(name="type", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The discriminator value. Required. Indexed OneLake retrieval activity.""" + indexed_one_lake_arguments: Optional["_models.KnowledgeBaseIndexedOneLakeActivityArguments"] = rest_field( + name="indexedOneLakeArguments", visibility=["read", "create", "update", "delete", "query"] + ) + """The indexed OneLake arguments for the retrieval activity.""" + + @overload + def __init__( + self, + *, + id: int, # pylint: disable=redefined-builtin + elapsed_ms: Optional[int] = None, + error: Optional["_models.KnowledgeBaseErrorDetail"] = None, + knowledge_source_name: Optional[str] = None, + query_time: Optional[datetime.datetime] = None, + count: Optional[int] = None, + indexed_one_lake_arguments: Optional["_models.KnowledgeBaseIndexedOneLakeActivityArguments"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.type = KnowledgeBaseActivityRecordType.INDEXED_ONELAKE # type: ignore + + class KnowledgeBaseIndexedOneLakeReference(KnowledgeBaseReference, discriminator="indexedOneLake"): """Represents an indexed OneLake document reference. @@ -898,6 +1092,128 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) +class KnowledgeBaseSearchIndexActivityArguments(_Model): # pylint: disable=name-too-long + """Represents the arguments the search index retrieval activity was run with. + + :ivar search: The search string used to query the search index. + :vartype search: str + :ivar filter: The filter string. + :vartype filter: str + :ivar source_data_fields: What fields were selected for search. + :vartype source_data_fields: + list[~azure.search.documents.indexes.models.SearchIndexFieldReference] + :ivar search_fields: What fields were searched against. + :vartype search_fields: list[~azure.search.documents.indexes.models.SearchIndexFieldReference] + :ivar semantic_configuration_name: What semantic configuration was used from the search index. + :vartype semantic_configuration_name: str + """ + + search: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The search string used to query the search index.""" + filter: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The filter string.""" + source_data_fields: Optional[list["_indexes_models3.SearchIndexFieldReference"]] = rest_field( + name="sourceDataFields", visibility=["read", "create", "update", "delete", "query"] + ) + """What fields were selected for search.""" + search_fields: Optional[list["_indexes_models3.SearchIndexFieldReference"]] = rest_field( + name="searchFields", visibility=["read", "create", "update", "delete", "query"] + ) + """What fields were searched against.""" + semantic_configuration_name: Optional[str] = rest_field( + name="semanticConfigurationName", visibility=["read", "create", "update", "delete", "query"] + ) + """What semantic configuration was used from the search index.""" + + @overload + def __init__( + self, + *, + search: Optional[str] = None, + filter: Optional[str] = None, # pylint: disable=redefined-builtin + source_data_fields: Optional[list["_indexes_models3.SearchIndexFieldReference"]] = None, + search_fields: Optional[list["_indexes_models3.SearchIndexFieldReference"]] = None, + semantic_configuration_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class KnowledgeBaseSearchIndexActivityRecord(KnowledgeBaseActivityRecord, discriminator="searchIndex"): + """Represents a search index retrieval activity record. + + :ivar id: The ID of the activity record. Required. + :vartype id: int + :ivar elapsed_ms: The elapsed time in milliseconds for the retrieval activity. + :vartype elapsed_ms: int + :ivar error: The error detail explaining why the operation failed. This property is only + included when the activity does not succeed. + :vartype error: ~azure.search.documents.knowledgebases.models.KnowledgeBaseErrorDetail + :ivar knowledge_source_name: The knowledge source for the retrieval activity. + :vartype knowledge_source_name: str + :ivar query_time: The query time for this retrieval activity. + :vartype query_time: ~datetime.datetime + :ivar count: The count of documents retrieved that were sufficiently relevant to pass the + reranker threshold. + :vartype count: int + :ivar type: The discriminator value. Required. Search index retrieval activity. + :vartype type: str or ~azure.search.documents.knowledgebases.models.SEARCH_INDEX + :ivar search_index_arguments: The search index arguments for the retrieval activity. + :vartype search_index_arguments: + ~azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexActivityArguments + """ + + knowledge_source_name: Optional[str] = rest_field( + name="knowledgeSourceName", visibility=["read", "create", "update", "delete", "query"] + ) + """The knowledge source for the retrieval activity.""" + query_time: Optional[datetime.datetime] = rest_field( + name="queryTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The query time for this retrieval activity.""" + count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The count of documents retrieved that were sufficiently relevant to pass the reranker + threshold.""" + type: Literal[KnowledgeBaseActivityRecordType.SEARCH_INDEX] = rest_discriminator(name="type", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The discriminator value. Required. Search index retrieval activity.""" + search_index_arguments: Optional["_models.KnowledgeBaseSearchIndexActivityArguments"] = rest_field( + name="searchIndexArguments", visibility=["read", "create", "update", "delete", "query"] + ) + """The search index arguments for the retrieval activity.""" + + @overload + def __init__( + self, + *, + id: int, # pylint: disable=redefined-builtin + elapsed_ms: Optional[int] = None, + error: Optional["_models.KnowledgeBaseErrorDetail"] = None, + knowledge_source_name: Optional[str] = None, + query_time: Optional[datetime.datetime] = None, + count: Optional[int] = None, + search_index_arguments: Optional["_models.KnowledgeBaseSearchIndexActivityArguments"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.type = KnowledgeBaseActivityRecordType.SEARCH_INDEX # type: ignore + + class KnowledgeBaseSearchIndexReference(KnowledgeBaseReference, discriminator="searchIndex"): """Represents an Azure Search document reference. @@ -943,6 +1259,121 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.type = KnowledgeBaseReferenceType.SEARCH_INDEX # type: ignore +class KnowledgeBaseWebActivityArguments(_Model): + """Represents the arguments the web retrieval activity was run with. + + :ivar search: The search string used to query the web. + :vartype search: str + :ivar language: The language for the retrieval activity. + :vartype language: str + :ivar market: The market for the retrieval activity. + :vartype market: str + :ivar count: The number of web results returned. + :vartype count: int + :ivar freshness: The freshness for the retrieval activity. + :vartype freshness: str + """ + + search: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The search string used to query the web.""" + language: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The language for the retrieval activity.""" + market: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The market for the retrieval activity.""" + count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The number of web results returned.""" + freshness: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The freshness for the retrieval activity.""" + + @overload + def __init__( + self, + *, + search: Optional[str] = None, + language: Optional[str] = None, + market: Optional[str] = None, + count: Optional[int] = None, + freshness: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class KnowledgeBaseWebActivityRecord(KnowledgeBaseActivityRecord, discriminator="web"): + """Represents a web retrieval activity record. + + :ivar id: The ID of the activity record. Required. + :vartype id: int + :ivar elapsed_ms: The elapsed time in milliseconds for the retrieval activity. + :vartype elapsed_ms: int + :ivar error: The error detail explaining why the operation failed. This property is only + included when the activity does not succeed. + :vartype error: ~azure.search.documents.knowledgebases.models.KnowledgeBaseErrorDetail + :ivar knowledge_source_name: The knowledge source for the retrieval activity. + :vartype knowledge_source_name: str + :ivar query_time: The query time for this retrieval activity. + :vartype query_time: ~datetime.datetime + :ivar count: The count of documents retrieved that were sufficiently relevant to pass the + reranker threshold. + :vartype count: int + :ivar type: The discriminator value. Required. Web retrieval activity. + :vartype type: str or ~azure.search.documents.knowledgebases.models.WEB + :ivar web_arguments: The web arguments for the retrieval activity. + :vartype web_arguments: + ~azure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityArguments + """ + + knowledge_source_name: Optional[str] = rest_field( + name="knowledgeSourceName", visibility=["read", "create", "update", "delete", "query"] + ) + """The knowledge source for the retrieval activity.""" + query_time: Optional[datetime.datetime] = rest_field( + name="queryTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The query time for this retrieval activity.""" + count: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The count of documents retrieved that were sufficiently relevant to pass the reranker + threshold.""" + type: Literal[KnowledgeBaseActivityRecordType.WEB] = rest_discriminator(name="type", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The discriminator value. Required. Web retrieval activity.""" + web_arguments: Optional["_models.KnowledgeBaseWebActivityArguments"] = rest_field( + name="webArguments", visibility=["read", "create", "update", "delete", "query"] + ) + """The web arguments for the retrieval activity.""" + + @overload + def __init__( + self, + *, + id: int, # pylint: disable=redefined-builtin + elapsed_ms: Optional[int] = None, + error: Optional["_models.KnowledgeBaseErrorDetail"] = None, + knowledge_source_name: Optional[str] = None, + query_time: Optional[datetime.datetime] = None, + count: Optional[int] = None, + web_arguments: Optional["_models.KnowledgeBaseWebActivityArguments"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.type = KnowledgeBaseActivityRecordType.WEB # type: ignore + + class KnowledgeBaseWebReference(KnowledgeBaseReference, discriminator="web"): """Represents a web document reference. diff --git a/sdk/search/azure-search-documents/azure/search/documents/models/_models.py b/sdk/search/azure-search-documents/azure/search/documents/models/_models.py index e41c0387b65c..25ee0e15a4cf 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/models/_models.py +++ b/sdk/search/azure-search-documents/azure/search/documents/models/_models.py @@ -49,10 +49,6 @@ class AutocompleteResult(_Model): """The list of returned Autocompleted items. Required.""" -class DebugInfo(_Model): - """Contains debugging information that can be used to further explore your search results.""" - - class DocumentDebugInfo(_Model): """Contains debugging information that can be used to further explore your search results. diff --git a/sdk/search/azure-search-documents/tsp-location.yaml b/sdk/search/azure-search-documents/tsp-location.yaml index e5e54626e777..596b9592acb5 100644 --- a/sdk/search/azure-search-documents/tsp-location.yaml +++ b/sdk/search/azure-search-documents/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/search/data-plane/Search -commit: d62196d5e224f0cd58f6dd2dbd082ed72300af5a +commit: 18ebae7ea8f6aefd83268aacdb1f480b24842726 repo: Azure/azure-rest-api-specs \ No newline at end of file