285 строки
25 KiB
YAML
285 строки
25 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill"
|
|
name: "AzureOpenAIEmbeddingSkill"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill"
|
|
summary: "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext&text=getContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs&text=getInputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getName()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs&text=getOutputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext&text=setContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 **AzureOpenAIEmbeddingSkill**</br> extends <xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.AzureOpenAIEmbeddingSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.AzureOpenAIEmbeddingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
name: "AzureOpenAIEmbeddingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.AzureOpenAIEmbeddingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
summary: "Creates an instance of Azure<wbr>Open<wbr>AIEmbedding<wbr>Skill class."
|
|
parameters:
|
|
- description: "the inputs value to set."
|
|
name: "inputs"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.InputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.InputFieldMappingEntry&text=InputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the outputs value to set."
|
|
name: "outputs"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.OutputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.OutputFieldMappingEntry&text=OutputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
desc: "Creates an instance of AzureOpenAIEmbeddingSkill class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Azure<wbr>Open<wbr>AIEmbedding<wbr>Skill 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 AzureOpenAIEmbeddingSkill 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 AzureOpenAIEmbeddingSkill from the JsonReader."
|
|
returns:
|
|
description: "An instance of AzureOpenAIEmbeddingSkill if the JsonReader was pointing to an instance of it, or null if\n it was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getApiKey()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getApiKey()"
|
|
name: "getApiKey()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getApiKey()"
|
|
summary: "Get the api<wbr>Key property: API key of the designated Azure OpenAI resource."
|
|
syntax: "public String getApiKey()"
|
|
desc: "Get the apiKey property: API key of the designated Azure OpenAI resource."
|
|
returns:
|
|
description: "the apiKey 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.AzureOpenAIEmbeddingSkill.getAuthIdentity()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getAuthIdentity()"
|
|
name: "getAuthIdentity()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getAuthIdentity()"
|
|
summary: "Get the auth<wbr>Identity property: The user-assigned managed identity used for outbound connections."
|
|
syntax: "public SearchIndexerDataIdentity getAuthIdentity()"
|
|
desc: "Get the authIdentity property: The user-assigned managed identity used for outbound connections."
|
|
returns:
|
|
description: "the authIdentity value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerDataIdentity?alt=com.azure.search.documents.indexes.models.SearchIndexerDataIdentity&text=SearchIndexerDataIdentity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getDeploymentName()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getDeploymentName()"
|
|
name: "getDeploymentName()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getDeploymentName()"
|
|
summary: "Get the deployment<wbr>Name property: ID of the Azure OpenAI model deployment on the designated resource."
|
|
syntax: "public String getDeploymentName()"
|
|
desc: "Get the deploymentName property: ID of the Azure OpenAI model deployment on the designated resource."
|
|
returns:
|
|
description: "the deploymentName 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.AzureOpenAIEmbeddingSkill.getDimensions()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getDimensions()"
|
|
name: "getDimensions()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getDimensions()"
|
|
summary: "Get the dimensions property: The number of dimensions the resulting output embeddings should have."
|
|
syntax: "public Integer getDimensions()"
|
|
desc: "Get the dimensions property: The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models."
|
|
returns:
|
|
description: "the dimensions value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getModelName()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getModelName()"
|
|
name: "getModelName()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getModelName()"
|
|
summary: "Get the model<wbr>Name property: The name of the embedding model that is deployed at the provided deployment<wbr>Id path."
|
|
syntax: "public AzureOpenAIModelName getModelName()"
|
|
desc: "Get the modelName property: The name of the embedding model that is deployed at the provided deploymentId path."
|
|
returns:
|
|
description: "the modelName value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIModelName?alt=com.azure.search.documents.indexes.models.AzureOpenAIModelName&text=AzureOpenAIModelName\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getOdataType()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getOdataType()"
|
|
name: "getOdataType()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getOdataType()"
|
|
summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of skill."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()"
|
|
syntax: "public String getOdataType()"
|
|
desc: "Get the odataType property: A URI fragment specifying the type of skill."
|
|
returns:
|
|
description: "the odataType 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.AzureOpenAIEmbeddingSkill.getResourceUrl()"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.getResourceUrl()"
|
|
name: "getResourceUrl()"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.getResourceUrl()"
|
|
summary: "Get the resource<wbr>Url property: The resource URI of the Azure OpenAI resource."
|
|
syntax: "public String getResourceUrl()"
|
|
desc: "Get the resourceUrl property: The resource URI of the Azure OpenAI resource."
|
|
returns:
|
|
description: "the resourceUrl 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.AzureOpenAIEmbeddingSkill.setApiKey(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setApiKey(String apiKey)"
|
|
name: "setApiKey(String apiKey)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setApiKey(String apiKey)"
|
|
summary: "Set the api<wbr>Key property: API key of the designated Azure OpenAI resource."
|
|
parameters:
|
|
- description: "the apiKey value to set."
|
|
name: "apiKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setApiKey(String apiKey)"
|
|
desc: "Set the apiKey property: API key of the designated Azure OpenAI resource."
|
|
returns:
|
|
description: "the AzureOpenAIEmbeddingSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setAuthIdentity(com.azure.search.documents.indexes.models.SearchIndexerDataIdentity)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setAuthIdentity(SearchIndexerDataIdentity authIdentity)"
|
|
name: "setAuthIdentity(SearchIndexerDataIdentity authIdentity)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setAuthIdentity(SearchIndexerDataIdentity authIdentity)"
|
|
summary: "Set the auth<wbr>Identity property: The user-assigned managed identity used for outbound connections."
|
|
parameters:
|
|
- description: "the authIdentity value to set."
|
|
name: "authIdentity"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerDataIdentity?alt=com.azure.search.documents.indexes.models.SearchIndexerDataIdentity&text=SearchIndexerDataIdentity\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setAuthIdentity(SearchIndexerDataIdentity authIdentity)"
|
|
desc: "Set the authIdentity property: The user-assigned managed identity used for outbound connections."
|
|
returns:
|
|
description: "the AzureOpenAIEmbeddingSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setContext(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setContext(String context)"
|
|
name: "setContext(String context)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setContext(String context)"
|
|
summary: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content)."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)"
|
|
parameters:
|
|
- name: "context"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setContext(String context)"
|
|
desc: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document."
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setDeploymentName(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setDeploymentName(String deploymentName)"
|
|
name: "setDeploymentName(String deploymentName)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setDeploymentName(String deploymentName)"
|
|
summary: "Set the deployment<wbr>Name property: ID of the Azure OpenAI model deployment on the designated resource."
|
|
parameters:
|
|
- description: "the deploymentName value to set."
|
|
name: "deploymentName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setDeploymentName(String deploymentName)"
|
|
desc: "Set the deploymentName property: ID of the Azure OpenAI model deployment on the designated resource."
|
|
returns:
|
|
description: "the AzureOpenAIEmbeddingSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setDescription(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setDescription(String description)"
|
|
name: "setDescription(String description)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setDescription(String description)"
|
|
summary: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)"
|
|
parameters:
|
|
- name: "description"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setDescription(String description)"
|
|
desc: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setDimensions(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setDimensions(Integer dimensions)"
|
|
name: "setDimensions(Integer dimensions)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setDimensions(Integer dimensions)"
|
|
summary: "Set the dimensions property: The number of dimensions the resulting output embeddings should have."
|
|
parameters:
|
|
- description: "the dimensions value to set."
|
|
name: "dimensions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setDimensions(Integer dimensions)"
|
|
desc: "Set the dimensions property: The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models."
|
|
returns:
|
|
description: "the AzureOpenAIEmbeddingSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setModelName(com.azure.search.documents.indexes.models.AzureOpenAIModelName)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setModelName(AzureOpenAIModelName modelName)"
|
|
name: "setModelName(AzureOpenAIModelName modelName)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setModelName(AzureOpenAIModelName modelName)"
|
|
summary: "Set the model<wbr>Name property: The name of the embedding model that is deployed at the provided deployment<wbr>Id path."
|
|
parameters:
|
|
- description: "the modelName value to set."
|
|
name: "modelName"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIModelName?alt=com.azure.search.documents.indexes.models.AzureOpenAIModelName&text=AzureOpenAIModelName\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setModelName(AzureOpenAIModelName modelName)"
|
|
desc: "Set the modelName property: The name of the embedding model that is deployed at the provided deploymentId path."
|
|
returns:
|
|
description: "the AzureOpenAIEmbeddingSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setName(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setName(String name)"
|
|
name: "setName(String name)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setName(String name)"
|
|
summary: "Set the name property: The name of the skill which uniquely identifies it within the skillset."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)"
|
|
parameters:
|
|
- name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setName(String name)"
|
|
desc: "Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '\\#'."
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setResourceUrl(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.setResourceUrl(String resourceUrl)"
|
|
name: "setResourceUrl(String resourceUrl)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.setResourceUrl(String resourceUrl)"
|
|
summary: "Set the resource<wbr>Url property: The resource URI of the Azure OpenAI resource."
|
|
parameters:
|
|
- description: "the resourceUrl value to set."
|
|
name: "resourceUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureOpenAIEmbeddingSkill setResourceUrl(String resourceUrl)"
|
|
desc: "Set the resourceUrl property: The resource URI of the Azure OpenAI resource."
|
|
returns:
|
|
description: "the AzureOpenAIEmbeddingSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill?alt=com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill&text=AzureOpenAIEmbeddingSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "AzureOpenAIEmbeddingSkill.toJson(JsonWriter jsonWriter)"
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.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: "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|