Class KnowledgeSourceIngestionParameters

java.lang.Object
com.azure.search.documents.indexes.models.KnowledgeSourceIngestionParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeSourceIngestionParameters>
public final class KnowledgeSourceIngestionParameters extends Object implements com.azure.json.JsonSerializable<KnowledgeSourceIngestionParameters>
Consolidates all general ingestion settings for knowledge sources.

  • Constructor Details

    • KnowledgeSourceIngestionParameters

      public KnowledgeSourceIngestionParameters()
      Creates an instance of KnowledgeSourceIngestionParameters class.

  • Method Details

    • getIdentity

      public SearchIndexerDataIdentity getIdentity()
      Get the identity property: An explicit identity to use for this knowledge source.
      Returns:
      the identity value.

    • setIdentity

      public KnowledgeSourceIngestionParameters setIdentity(SearchIndexerDataIdentity identity)
      Set the identity property: An explicit identity to use for this knowledge source.
      Parameters:
      identity - the identity value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • getEmbeddingModel

      public KnowledgeSourceVectorizer getEmbeddingModel()
      Get the embeddingModel property: Optional vectorizer configuration for vectorizing content.
      Returns:
      the embeddingModel value.

    • setEmbeddingModel

      public KnowledgeSourceIngestionParameters setEmbeddingModel(KnowledgeSourceVectorizer embeddingModel)
      Set the embeddingModel property: Optional vectorizer configuration for vectorizing content.
      Parameters:
      embeddingModel - the embeddingModel value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • getChatCompletionModel

      public KnowledgeBaseModel getChatCompletionModel()
      Get the chatCompletionModel property: Optional chat completion model for image verbalization or context extraction.
      Returns:
      the chatCompletionModel value.

    • setChatCompletionModel

      public KnowledgeSourceIngestionParameters setChatCompletionModel(KnowledgeBaseModel chatCompletionModel)
      Set the chatCompletionModel property: Optional chat completion model for image verbalization or context extraction.
      Parameters:
      chatCompletionModel - the chatCompletionModel value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • isDisableImageVerbalization

      public Boolean isDisableImageVerbalization()
      Get the disableImageVerbalization property: Indicates whether image verbalization should be disabled. Default is false.
      Returns:
      the disableImageVerbalization value.

    • setDisableImageVerbalization

      public KnowledgeSourceIngestionParameters setDisableImageVerbalization(Boolean disableImageVerbalization)
      Set the disableImageVerbalization property: Indicates whether image verbalization should be disabled. Default is false.
      Parameters:
      disableImageVerbalization - the disableImageVerbalization value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • getIngestionSchedule

      public IndexingSchedule getIngestionSchedule()
      Get the ingestionSchedule property: Optional schedule for data ingestion.
      Returns:
      the ingestionSchedule value.

    • setIngestionSchedule

      public KnowledgeSourceIngestionParameters setIngestionSchedule(IndexingSchedule ingestionSchedule)
      Set the ingestionSchedule property: Optional schedule for data ingestion.
      Parameters:
      ingestionSchedule - the ingestionSchedule value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • getIngestionPermissionOptions

      public List<KnowledgeSourceIngestionPermissionOption> getIngestionPermissionOptions()
      Get the ingestionPermissionOptions property: Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source.
      Returns:
      the ingestionPermissionOptions value.

    • setIngestionPermissionOptions

      public KnowledgeSourceIngestionParameters setIngestionPermissionOptions(List<KnowledgeSourceIngestionPermissionOption> ingestionPermissionOptions)
      Set the ingestionPermissionOptions property: Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source.
      Parameters:
      ingestionPermissionOptions - the ingestionPermissionOptions value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • getContentExtractionMode

      public KnowledgeSourceContentExtractionMode getContentExtractionMode()
      Get the contentExtractionMode property: Optional content extraction mode. Default is 'minimal'.
      Returns:
      the contentExtractionMode value.

    • setContentExtractionMode

      public KnowledgeSourceIngestionParameters setContentExtractionMode(KnowledgeSourceContentExtractionMode contentExtractionMode)
      Set the contentExtractionMode property: Optional content extraction mode. Default is 'minimal'.
      Parameters:
      contentExtractionMode - the contentExtractionMode value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • getAiServices

      public AIServices getAiServices()
      Get the aiServices property: Optional AI Services configuration for content processing.
      Returns:
      the aiServices value.

    • setAiServices

      public KnowledgeSourceIngestionParameters setAiServices(AIServices aiServices)
      Set the aiServices property: Optional AI Services configuration for content processing.
      Parameters:
      aiServices - the aiServices value to set.
      Returns:
      the KnowledgeSourceIngestionParameters object itself.

    • toJson

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

    • fromJson

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