399 строки
37 KiB
YAML
399 строки
37 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.SearchIndexClient"
|
|
fullName: "com.azure.search.SearchIndexClient"
|
|
name: "SearchIndexClient"
|
|
nameWithType: "SearchIndexClient"
|
|
summary: "Cognitive Search Synchronous Client to query an index and upload, merge, or delete documents"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **SearchIndexClient**"
|
|
methods:
|
|
- uid: "com.azure.search.SearchIndexClient.autocomplete(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.search.SearchIndexClient.autocomplete(String searchText, String suggesterName)"
|
|
name: "autocomplete(String searchText, String suggesterName)"
|
|
nameWithType: "SearchIndexClient.autocomplete(String searchText, String suggesterName)"
|
|
summary: "Autocompletes incomplete query terms based on input text and matching terms in the index."
|
|
parameters:
|
|
- description: "search text"
|
|
name: "searchText"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "suggester name"
|
|
name: "suggesterName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AutocompletePagedIterable autocomplete(String searchText, String suggesterName)"
|
|
desc: "Autocompletes incomplete query terms based on input text and matching terms in the index."
|
|
returns:
|
|
description: "auto complete result."
|
|
type: "<xref href=\"com.azure.search.util.AutocompletePagedIterable?alt=com.azure.search.util.AutocompletePagedIterable&text=AutocompletePagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.autocomplete(java.lang.String,java.lang.String,com.azure.search.models.AutocompleteOptions,com.azure.search.models.RequestOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions, RequestOptions requestOptions, Context context)"
|
|
name: "autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions, RequestOptions requestOptions, Context context)"
|
|
nameWithType: "SearchIndexClient.autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions, RequestOptions requestOptions, Context context)"
|
|
summary: "Autocompletes incomplete query terms based on input text and matching terms in the index."
|
|
parameters:
|
|
- description: "search text"
|
|
name: "searchText"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "suggester name"
|
|
name: "suggesterName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "autocomplete options"
|
|
name: "autocompleteOptions"
|
|
type: "<xref href=\"com.azure.search.models.AutocompleteOptions?alt=com.azure.search.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional parameters for the operation. Contains the tracking ID sent with the request to\n help with debugging"
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.search.models.RequestOptions?alt=com.azure.search.models.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional context that is passed through the HTTP pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AutocompletePagedIterable autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions, RequestOptions requestOptions, Context context)"
|
|
desc: "Autocompletes incomplete query terms based on input text and matching terms in the index."
|
|
returns:
|
|
description: "auto complete result."
|
|
type: "<xref href=\"com.azure.search.util.AutocompletePagedIterable?alt=com.azure.search.util.AutocompletePagedIterable&text=AutocompletePagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.deleteDocuments(java.lang.Iterable<?>)"
|
|
fullName: "com.azure.search.SearchIndexClient.deleteDocuments(Iterable<?> documents)"
|
|
name: "deleteDocuments(Iterable<?> documents)"
|
|
nameWithType: "SearchIndexClient.deleteDocuments(Iterable<?> documents)"
|
|
summary: "Deletes a collection of documents from the target index."
|
|
parameters:
|
|
- description: "collection of documents to delete from the target Index. Fields other than the key are ignored."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
syntax: "public IndexDocumentsResult deleteDocuments(Iterable<?> documents)"
|
|
desc: "Deletes a collection of documents from the target index."
|
|
returns:
|
|
description: "document index result."
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.deleteDocumentsWithResponse(java.lang.Iterable<?>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.deleteDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
name: "deleteDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
nameWithType: "SearchIndexClient.deleteDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
summary: "Deletes a collection of documents from the target index."
|
|
parameters:
|
|
- description: "collection of documents to delete from the target Index. Fields other than the key are ignored."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<IndexDocumentsResult> deleteDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
desc: "Deletes a collection of documents from the target index."
|
|
returns:
|
|
description: "response containing a document index result."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.SearchIndexClient.getDocument(java.lang.String)"
|
|
fullName: "com.azure.search.SearchIndexClient.getDocument(String key)"
|
|
name: "getDocument(String key)"
|
|
nameWithType: "SearchIndexClient.getDocument(String key)"
|
|
summary: "Retrieves a document from the Azure Cognitive Search index."
|
|
parameters:
|
|
- description: "The key of the document to retrieve."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SearchDocument getDocument(String key)"
|
|
desc: "Retrieves a document from the Azure Cognitive Search index.\n\nView [naming rules][] for guidelines on constructing valid document keys.\n\n\n[naming rules]: https://docs.microsoft.com/rest/api/searchservice/Naming-rules"
|
|
returns:
|
|
description: "document object"
|
|
type: "<xref href=\"com.azure.search.SearchDocument?alt=com.azure.search.SearchDocument&text=SearchDocument\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.getDocumentCount()"
|
|
fullName: "com.azure.search.SearchIndexClient.getDocumentCount()"
|
|
name: "getDocumentCount()"
|
|
nameWithType: "SearchIndexClient.getDocumentCount()"
|
|
summary: "Queries the number of documents in the search index."
|
|
syntax: "public long getDocumentCount()"
|
|
desc: "Queries the number of documents in the search index."
|
|
returns:
|
|
description: "the number of documents."
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.getDocumentCountWithResponse(com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.getDocumentCountWithResponse(Context context)"
|
|
name: "getDocumentCountWithResponse(Context context)"
|
|
nameWithType: "SearchIndexClient.getDocumentCountWithResponse(Context context)"
|
|
summary: "Queries the number of documents in the search index."
|
|
parameters:
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Long> getDocumentCountWithResponse(Context context)"
|
|
desc: "Queries the number of documents in the search index."
|
|
returns:
|
|
description: "response containing the number of documents."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>>"
|
|
- uid: "com.azure.search.SearchIndexClient.getDocumentWithResponse(java.lang.String,java.util.List<java.lang.String>,com.azure.search.models.RequestOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.getDocumentWithResponse(String key, List<String> selectedFields, RequestOptions requestOptions, Context context)"
|
|
name: "getDocumentWithResponse(String key, List<String> selectedFields, RequestOptions requestOptions, Context context)"
|
|
nameWithType: "SearchIndexClient.getDocumentWithResponse(String key, List<String> selectedFields, RequestOptions requestOptions, Context context)"
|
|
summary: "Retrieves a document from the Azure Cognitive Search index."
|
|
parameters:
|
|
- description: "The key of the document to retrieve."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "List of field names to retrieve for the document; Any field not retrieved will have null or\n default as its corresponding property value in the returned object."
|
|
name: "selectedFields"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "additional parameters for the operation. Contains the tracking ID sent with the request to\n help with debugging"
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.search.models.RequestOptions?alt=com.azure.search.models.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<SearchDocument> getDocumentWithResponse(String key, List<String> selectedFields, RequestOptions requestOptions, Context context)"
|
|
desc: "Retrieves a document from the Azure Cognitive Search index.\n\nView [naming rules][] for guidelines on constructing valid document keys.\n\n\n[naming rules]: https://docs.microsoft.com/rest/api/searchservice/Naming-rules"
|
|
returns:
|
|
description: "response containing a document object"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.SearchDocument?alt=com.azure.search.SearchDocument&text=SearchDocument\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.SearchIndexClient.getEndpoint()"
|
|
fullName: "com.azure.search.SearchIndexClient.getEndpoint()"
|
|
name: "getEndpoint()"
|
|
nameWithType: "SearchIndexClient.getEndpoint()"
|
|
summary: "Gets the endpoint for the Azure Cognitive Search service."
|
|
syntax: "public String getEndpoint()"
|
|
desc: "Gets the endpoint for the Azure Cognitive Search service."
|
|
returns:
|
|
description: "the endpoint value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.SearchIndexClient.getIndexName()"
|
|
fullName: "com.azure.search.SearchIndexClient.getIndexName()"
|
|
name: "getIndexName()"
|
|
nameWithType: "SearchIndexClient.getIndexName()"
|
|
summary: "Gets the name of the Azure Cognitive Search index."
|
|
syntax: "public String getIndexName()"
|
|
desc: "Gets the name of the Azure Cognitive Search index."
|
|
returns:
|
|
description: "the indexName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.SearchIndexClient.getServiceVersion()"
|
|
fullName: "com.azure.search.SearchIndexClient.getServiceVersion()"
|
|
name: "getServiceVersion()"
|
|
nameWithType: "SearchIndexClient.getServiceVersion()"
|
|
summary: "Gets the version of the Search service the client is using."
|
|
syntax: "public SearchServiceVersion getServiceVersion()"
|
|
desc: "Gets the version of the Search service the client is using."
|
|
returns:
|
|
description: "The version of the Search service the client is using."
|
|
type: "<xref href=\"com.azure.search.SearchServiceVersion?alt=com.azure.search.SearchServiceVersion&text=SearchServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.indexDocuments(com.azure.search.models.IndexDocumentsBatch<?>)"
|
|
fullName: "com.azure.search.SearchIndexClient.indexDocuments(IndexDocumentsBatch<?> batch)"
|
|
name: "indexDocuments(IndexDocumentsBatch<?> batch)"
|
|
nameWithType: "SearchIndexClient.indexDocuments(IndexDocumentsBatch<?> batch)"
|
|
summary: "Sends a batch of upload, merge, and/or delete actions to the search index."
|
|
parameters:
|
|
- description: "The batch of index actions"
|
|
name: "batch"
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsBatch?alt=com.azure.search.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><?>"
|
|
syntax: "public IndexDocumentsResult indexDocuments(IndexDocumentsBatch<?> batch)"
|
|
desc: "Sends a batch of upload, merge, and/or delete actions to the search index."
|
|
returns:
|
|
description: "Response containing the status of operations for all actions in the batch"
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.indexDocumentsWithResponse(com.azure.search.models.IndexDocumentsBatch<?>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.indexDocumentsWithResponse(IndexDocumentsBatch<?> batch, Context context)"
|
|
name: "indexDocumentsWithResponse(IndexDocumentsBatch<?> batch, Context context)"
|
|
nameWithType: "SearchIndexClient.indexDocumentsWithResponse(IndexDocumentsBatch<?> batch, Context context)"
|
|
summary: "Sends a batch of upload, merge, and/or delete actions to the search index."
|
|
parameters:
|
|
- description: "The batch of index actions"
|
|
name: "batch"
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsBatch?alt=com.azure.search.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><?>"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsBatch<?> batch, Context context)"
|
|
desc: "Sends a batch of upload, merge, and/or delete actions to the search index."
|
|
returns:
|
|
description: "Response containing the status of operations for all actions in the batch"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.SearchIndexClient.mergeDocuments(java.lang.Iterable<?>)"
|
|
fullName: "com.azure.search.SearchIndexClient.mergeDocuments(Iterable<?> documents)"
|
|
name: "mergeDocuments(Iterable<?> documents)"
|
|
nameWithType: "SearchIndexClient.mergeDocuments(Iterable<?> documents)"
|
|
summary: "Merges a collection of documents with existing documents in the target index."
|
|
parameters:
|
|
- description: "collection of documents to be merged"
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
syntax: "public IndexDocumentsResult mergeDocuments(Iterable<?> documents)"
|
|
desc: "Merges a collection of documents with existing documents in the target index.\n\nIf the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, `0` for `int` or `false` for `boolean`), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type `Integer` instead of `int`)."
|
|
returns:
|
|
description: "document index result"
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.mergeDocumentsWithResponse(java.lang.Iterable<?>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.mergeDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
name: "mergeDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
nameWithType: "SearchIndexClient.mergeDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
summary: "Merges a collection of documents with existing documents in the target index."
|
|
parameters:
|
|
- description: "collection of documents to be merged"
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<IndexDocumentsResult> mergeDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
desc: "Merges a collection of documents with existing documents in the target index.\n\nIf the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, `0` for `int` or `false` for `boolean`), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type `Integer` instead of `int`)."
|
|
returns:
|
|
description: "response containing the document index result."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.SearchIndexClient.mergeOrUploadDocuments(java.lang.Iterable<?>)"
|
|
fullName: "com.azure.search.SearchIndexClient.mergeOrUploadDocuments(Iterable<?> documents)"
|
|
name: "mergeOrUploadDocuments(Iterable<?> documents)"
|
|
nameWithType: "SearchIndexClient.mergeOrUploadDocuments(Iterable<?> documents)"
|
|
summary: "This action behaves like merge if a document with the given key already exists in the index."
|
|
parameters:
|
|
- description: "collection of documents to be merged, if exists, otherwise uploaded"
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
syntax: "public IndexDocumentsResult mergeOrUploadDocuments(Iterable<?> documents)"
|
|
desc: "This action behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document.\n\nIf the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, `0` for `int` or `false` for `boolean`), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type `Integer` instead of `int`)."
|
|
returns:
|
|
description: "document index result"
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.mergeOrUploadDocumentsWithResponse(java.lang.Iterable<?>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.mergeOrUploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
name: "mergeOrUploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
nameWithType: "SearchIndexClient.mergeOrUploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
summary: "This action behaves like merge if a document with the given key already exists in the index."
|
|
parameters:
|
|
- description: "collection of documents to be merged, if exists, otherwise uploaded"
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<IndexDocumentsResult> mergeOrUploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
desc: "This action behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document.\n\nIf the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, `0` for `int` or `false` for `boolean`), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type `Integer` instead of `int`)."
|
|
returns:
|
|
description: "response containing a document index result"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.SearchIndexClient.search(java.lang.String)"
|
|
fullName: "com.azure.search.SearchIndexClient.search(String searchText)"
|
|
name: "search(String searchText)"
|
|
nameWithType: "SearchIndexClient.search(String searchText)"
|
|
summary: "Searches for documents in the Azure Cognitive Search index."
|
|
parameters:
|
|
- description: "A full-text search query expression."
|
|
name: "searchText"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SearchPagedIterable search(String searchText)"
|
|
desc: "Searches for documents in the Azure Cognitive Search index.\n\nIf `searchText` is set to `null` or `\"*\"` all documents will be matched, see [simple query syntax in Azure Search][] for more information about search query syntax.\n\n\n[simple query syntax in Azure Search]: https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.search.util.SearchPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchPagedIterable\"></xref> that iterates over <xref uid=\"com.azure.search.models.SearchResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchResult\"></xref> objects and provides access to the\n <xref uid=\"com.azure.search.util.SearchPagedResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchPagedResponse\"></xref> object for each page containing HTTP response and count, facet, and coverage\n information."
|
|
type: "<xref href=\"com.azure.search.util.SearchPagedIterable?alt=com.azure.search.util.SearchPagedIterable&text=SearchPagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.search(java.lang.String,com.azure.search.models.SearchOptions,com.azure.search.models.RequestOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.search(String searchText, SearchOptions searchOptions, RequestOptions requestOptions, Context context)"
|
|
name: "search(String searchText, SearchOptions searchOptions, RequestOptions requestOptions, Context context)"
|
|
nameWithType: "SearchIndexClient.search(String searchText, SearchOptions searchOptions, RequestOptions requestOptions, Context context)"
|
|
summary: "Searches for documents in the Azure Cognitive Search index."
|
|
parameters:
|
|
- description: "A full-text search query expression."
|
|
name: "searchText"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Parameters to further refine the search query"
|
|
name: "searchOptions"
|
|
type: "<xref href=\"com.azure.search.models.SearchOptions?alt=com.azure.search.models.SearchOptions&text=SearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional parameters for the operation. Contains the tracking ID sent with the request to\n help with debugging"
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.search.models.RequestOptions?alt=com.azure.search.models.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SearchPagedIterable search(String searchText, SearchOptions searchOptions, RequestOptions requestOptions, Context context)"
|
|
desc: "Searches for documents in the Azure Cognitive Search index.\n\nIf `searchText` is set to `null` or `\"*\"` all documents will be matched, see [simple query syntax in Azure Search][] for more information about search query syntax.\n\n\n[simple query syntax in Azure Search]: https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.search.util.SearchPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchPagedIterable\"></xref> that iterates over <xref uid=\"com.azure.search.models.SearchResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchResult\"></xref> objects and provides access to the\n <xref uid=\"com.azure.search.util.SearchPagedResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchPagedResponse\"></xref> object for each page containing HTTP response and count, facet, and coverage\n information."
|
|
type: "<xref href=\"com.azure.search.util.SearchPagedIterable?alt=com.azure.search.util.SearchPagedIterable&text=SearchPagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.suggest(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.search.SearchIndexClient.suggest(String searchText, String suggesterName)"
|
|
name: "suggest(String searchText, String suggesterName)"
|
|
nameWithType: "SearchIndexClient.suggest(String searchText, String suggesterName)"
|
|
summary: "Suggests documents in the index that match the given partial query."
|
|
parameters:
|
|
- description: "The search text on which to base suggestions"
|
|
name: "searchText"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the suggester as specified in the suggesters collection that's part of the index\n definition"
|
|
name: "suggesterName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SuggestPagedIterable suggest(String searchText, String suggesterName)"
|
|
desc: "Suggests documents in the index that match the given partial query."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.search.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref> that iterates over <xref uid=\"com.azure.search.models.SuggestResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestResult\"></xref> objects and provides access to\n the <xref uid=\"com.azure.search.util.SuggestPagedResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedResponse\"></xref> object for each page containing HTTP response and coverage information."
|
|
type: "<xref href=\"com.azure.search.util.SuggestPagedIterable?alt=com.azure.search.util.SuggestPagedIterable&text=SuggestPagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.suggest(java.lang.String,java.lang.String,com.azure.search.models.SuggestOptions,com.azure.search.models.RequestOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.suggest(String searchText, String suggesterName, SuggestOptions suggestOptions, RequestOptions requestOptions, Context context)"
|
|
name: "suggest(String searchText, String suggesterName, SuggestOptions suggestOptions, RequestOptions requestOptions, Context context)"
|
|
nameWithType: "SearchIndexClient.suggest(String searchText, String suggesterName, SuggestOptions suggestOptions, RequestOptions requestOptions, Context context)"
|
|
summary: "Suggests documents in the index that match the given partial query."
|
|
parameters:
|
|
- description: "The search text on which to base suggestions"
|
|
name: "searchText"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the suggester as specified in the suggesters collection that's part of the index\n definition"
|
|
name: "suggesterName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Parameters to further refine the suggestion query."
|
|
name: "suggestOptions"
|
|
type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional parameters for the operation. Contains the tracking ID sent with the request to\n help with debugging"
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.search.models.RequestOptions?alt=com.azure.search.models.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SuggestPagedIterable suggest(String searchText, String suggesterName, SuggestOptions suggestOptions, RequestOptions requestOptions, Context context)"
|
|
desc: "Suggests documents in the index that match the given partial query."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.search.util.SuggestPagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedIterable\"></xref> that iterates over <xref uid=\"com.azure.search.models.SuggestResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestResult\"></xref> objects and provides access to\n the <xref uid=\"com.azure.search.util.SuggestPagedResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SuggestPagedResponse\"></xref> object for each page containing HTTP response and coverage information."
|
|
type: "<xref href=\"com.azure.search.util.SuggestPagedIterable?alt=com.azure.search.util.SuggestPagedIterable&text=SuggestPagedIterable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.uploadDocuments(java.lang.Iterable<?>)"
|
|
fullName: "com.azure.search.SearchIndexClient.uploadDocuments(Iterable<?> documents)"
|
|
name: "uploadDocuments(Iterable<?> documents)"
|
|
nameWithType: "SearchIndexClient.uploadDocuments(Iterable<?> documents)"
|
|
summary: "Uploads a collection of documents to the target index."
|
|
parameters:
|
|
- description: "collection of documents to upload to the target Index."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
syntax: "public IndexDocumentsResult uploadDocuments(Iterable<?> documents)"
|
|
desc: "Uploads a collection of documents to the target index."
|
|
returns:
|
|
description: "document index result."
|
|
type: "<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.SearchIndexClient.uploadDocumentsWithResponse(java.lang.Iterable<?>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.search.SearchIndexClient.uploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
name: "uploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
nameWithType: "SearchIndexClient.uploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
summary: "Uploads a collection of documents to the target index."
|
|
parameters:
|
|
- description: "collection of documents to upload to the target Index."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><?>"
|
|
- description: "additional context that is passed through the Http pipeline during the service call"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<IndexDocumentsResult> uploadDocumentsWithResponse(Iterable<?> documents, Context context)"
|
|
desc: "Uploads a collection of documents to the target index."
|
|
returns:
|
|
description: "response containing the document index result."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.models.IndexDocumentsResult?alt=com.azure.search.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Cognitive Search Synchronous Client to query an index and upload, merge, or delete documents"
|
|
metadata: {}
|
|
package: "com.azure.search"
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|