Package com.azure.ai.openai.models

Class PineconeChatExtensionParameters

java.lang.Object
com.azure.ai.openai.models.PineconeChatExtensionParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<PineconeChatExtensionParameters>
public final class PineconeChatExtensionParameters extends Object implements com.azure.json.JsonSerializable<PineconeChatExtensionParameters>
Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey.

  • Constructor Details

    • PineconeChatExtensionParameters

      public PineconeChatExtensionParameters(String environment, String indexName, PineconeFieldMappingOptions fieldsMapping, OnYourDataVectorizationSource embeddingDependency)
      Creates an instance of PineconeChatExtensionParameters class.
      Parameters:
      environment - the environment value to set.
      indexName - the indexName value to set.
      fieldsMapping - the fieldsMapping value to set.
      embeddingDependency - the embeddingDependency value to set.

  • Method Details

    • getAuthentication

      public OnYourDataAuthenticationOptions getAuthentication()
      Get the authentication property: The authentication method to use when accessing the defined data source. Each data source type supports a specific set of available authentication methods; please see the documentation of the data source for supported mechanisms. If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) authentication.
      Returns:
      the authentication value.

    • setAuthentication

      public PineconeChatExtensionParameters setAuthentication(OnYourDataAuthenticationOptions authentication)
      Set the authentication property: The authentication method to use when accessing the defined data source. Each data source type supports a specific set of available authentication methods; please see the documentation of the data source for supported mechanisms. If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) authentication.
      Parameters:
      authentication - the authentication value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • getTopNDocuments

      public Integer getTopNDocuments()
      Get the topNDocuments property: The configured top number of documents to feature for the configured query.
      Returns:
      the topNDocuments value.

    • setTopNDocuments

      public PineconeChatExtensionParameters setTopNDocuments(Integer topNDocuments)
      Set the topNDocuments property: The configured top number of documents to feature for the configured query.
      Parameters:
      topNDocuments - the topNDocuments value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • isInScope

      public Boolean isInScope()
      Get the inScope property: Whether queries should be restricted to use of indexed data.
      Returns:
      the inScope value.

    • setInScope

      public PineconeChatExtensionParameters setInScope(Boolean inScope)
      Set the inScope property: Whether queries should be restricted to use of indexed data.
      Parameters:
      inScope - the inScope value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • getStrictness

      public Integer getStrictness()
      Get the strictness property: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
      Returns:
      the strictness value.

    • setStrictness

      public PineconeChatExtensionParameters setStrictness(Integer strictness)
      Set the strictness property: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
      Parameters:
      strictness - the strictness value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • getRoleInformation

      public String getRoleInformation()
      Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.
      Returns:
      the roleInformation value.

    • setRoleInformation

      public PineconeChatExtensionParameters setRoleInformation(String roleInformation)
      Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit.
      Parameters:
      roleInformation - the roleInformation value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • getEnvironment

      public String getEnvironment()
      Get the environment property: The environment name of Pinecone.
      Returns:
      the environment value.

    • getIndexName

      public String getIndexName()
      Get the indexName property: The name of the Pinecone database index.
      Returns:
      the indexName value.

    • getFieldsMapping

      public PineconeFieldMappingOptions getFieldsMapping()
      Get the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
      Returns:
      the fieldsMapping value.

    • getEmbeddingDependency

      public OnYourDataVectorizationSource getEmbeddingDependency()
      Get the embeddingDependency property: The embedding dependency for vector search.
      Returns:
      the embeddingDependency value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<PineconeChatExtensionParameters>
      Throws:
      IOException

    • fromJson

      public static PineconeChatExtensionParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PineconeChatExtensionParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PineconeChatExtensionParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PineconeChatExtensionParameters.

    • getMaxSearchQueries

      public Integer getMaxSearchQueries()
      Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.
      Returns:
      the maxSearchQueries value.

    • setMaxSearchQueries

      public PineconeChatExtensionParameters setMaxSearchQueries(Integer maxSearchQueries)
      Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.
      Parameters:
      maxSearchQueries - the maxSearchQueries value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • isAllowPartialResult

      public Boolean isAllowPartialResult()
      Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails.
      Returns:
      the allowPartialResult value.

    • setAllowPartialResult

      public PineconeChatExtensionParameters setAllowPartialResult(Boolean allowPartialResult)
      Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails.
      Parameters:
      allowPartialResult - the allowPartialResult value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.

    • getIncludeContexts

      public List<OnYourDataContextProperty> getIncludeContexts()
      Get the includeContexts property: The included properties of the output context. If not specified, the default value is `citations` and `intent`.
      Returns:
      the includeContexts value.

    • setIncludeContexts

      public PineconeChatExtensionParameters setIncludeContexts(List<OnYourDataContextProperty> includeContexts)
      Set the includeContexts property: The included properties of the output context. If not specified, the default value is `citations` and `intent`.
      Parameters:
      includeContexts - the includeContexts value to set.
      Returns:
      the PineconeChatExtensionParameters object itself.