com.azure.search.documents.indexes.models.VectorSearchProfile.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.VectorSearchProfile"
fullName: "com.azure.search.documents.indexes.models.VectorSearchProfile"
name: "VectorSearchProfile"
nameWithType: "VectorSearchProfile"
summary: "Defines a combination of configurations to use with vector search."
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 **VectorSearchProfile**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.VectorSearchProfile?alt=com.azure.search.documents.indexes.models.VectorSearchProfile&text=VectorSearchProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.VectorSearchProfile.VectorSearchProfile(java.lang.String,java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.VectorSearchProfile.VectorSearchProfile(String name, String algorithmConfigurationName)"
  name: "VectorSearchProfile(String name, String algorithmConfigurationName)"
  nameWithType: "VectorSearchProfile.VectorSearchProfile(String name, String algorithmConfigurationName)"
  summary: "Creates an instance of Vector<wbr>Search<wbr>Profile class."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the algorithmConfigurationName value to set."
    name: "algorithmConfigurationName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public VectorSearchProfile(String name, String algorithmConfigurationName)"
  desc: "Creates an instance of VectorSearchProfile class."
methods:
- uid: "com.azure.search.documents.indexes.models.VectorSearchProfile.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.VectorSearchProfile.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "VectorSearchProfile.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Vector<wbr>Search<wbr>Profile from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static VectorSearchProfile fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of VectorSearchProfile from the JsonReader."
  returns:
    description: "An instance of VectorSearchProfile if the JsonReader was pointing to an instance of it, or null if it was\n     pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchProfile?alt=com.azure.search.documents.indexes.models.VectorSearchProfile&text=VectorSearchProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.VectorSearchProfile.getAlgorithmConfigurationName()"
  fullName: "com.azure.search.documents.indexes.models.VectorSearchProfile.getAlgorithmConfigurationName()"
  name: "getAlgorithmConfigurationName()"
  nameWithType: "VectorSearchProfile.getAlgorithmConfigurationName()"
  summary: "Get the algorithm<wbr>Configuration<wbr>Name property: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters."
  syntax: "public String getAlgorithmConfigurationName()"
  desc: "Get the algorithmConfigurationName property: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters."
  returns:
    description: "the algorithmConfigurationName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.VectorSearchProfile.getName()"
  fullName: "com.azure.search.documents.indexes.models.VectorSearchProfile.getName()"
  name: "getName()"
  nameWithType: "VectorSearchProfile.getName()"
  summary: "Get the name property: The name to associate with this particular vector search profile."
  syntax: "public String getName()"
  desc: "Get the name property: The name to associate with this particular vector search profile."
  returns:
    description: "the name value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.VectorSearchProfile.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.VectorSearchProfile.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "VectorSearchProfile.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines a combination of configurations to use with vector search."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.VectorSearchProfile?alt=com.azure.search.documents.indexes.models.VectorSearchProfile&text=VectorSearchProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.6.6