KnowledgeSourceIngestionParameters Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.knowledgebases.models.KnowledgeSourceIngestionParameters

Implements

JsonSerializable<KnowledgeSourceIngestionParameters>

public final class KnowledgeSourceIngestionParameters
implements JsonSerializable<KnowledgeSourceIngestionParameters>

Consolidates all general ingestion settings for knowledge sources.

Constructor Summary

Constructor Description
KnowledgeSourceIngestionParameters()

Creates an instance of KnowledgeSourceIngestionParameters class.

Method Summary

Modifier and Type Method and Description
static KnowledgeSourceIngestionParameters fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeSourceIngestionParameters from the JsonReader.
AiServices getAiServices()

Get the aiServices property: Optional AI Services configuration for content processing.
KnowledgeBaseModel getChatCompletionModel()

Get the chatCompletionModel property: Optional chat completion model for image verbalization or context extraction.
KnowledgeSourceContentExtractionMode getContentExtractionMode()

Get the contentExtractionMode property: Optional content extraction mode.
KnowledgeSourceVectorizer getEmbeddingModel()

Get the embeddingModel property: Optional vectorizer configuration for vectorizing content.
SearchIndexerDataIdentity getIdentity()

Get the identity property: An explicit identity to use for this knowledge source.
IndexingSchedule getIngestionSchedule()

Get the ingestionSchedule property: Optional schedule for data ingestion.
Boolean isDisableImageVerbalization()

Get the disableImageVerbalization property: Indicates whether image verbalization should be disabled.
KnowledgeSourceIngestionParameters setAiServices(AiServices aiServices)

Set the aiServices property: Optional AI Services configuration for content processing.
KnowledgeSourceIngestionParameters setChatCompletionModel(KnowledgeBaseModel chatCompletionModel)

Set the chatCompletionModel property: Optional chat completion model for image verbalization or context extraction.
KnowledgeSourceIngestionParameters setContentExtractionMode(KnowledgeSourceContentExtractionMode contentExtractionMode)

Set the contentExtractionMode property: Optional content extraction mode.
KnowledgeSourceIngestionParameters setDisableImageVerbalization(Boolean disableImageVerbalization)

Set the disableImageVerbalization property: Indicates whether image verbalization should be disabled.
KnowledgeSourceIngestionParameters setEmbeddingModel(KnowledgeSourceVectorizer embeddingModel)

Set the embeddingModel property: Optional vectorizer configuration for vectorizing content.
KnowledgeSourceIngestionParameters setIdentity(SearchIndexerDataIdentity identity)

Set the identity property: An explicit identity to use for this knowledge source.
KnowledgeSourceIngestionParameters setIngestionSchedule(IndexingSchedule ingestionSchedule)

Set the ingestionSchedule property: Optional schedule for data ingestion.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeSourceIngestionParameters

public KnowledgeSourceIngestionParameters()

Creates an instance of KnowledgeSourceIngestionParameters class.

Method Details

fromJson

public static KnowledgeSourceIngestionParameters fromJson(JsonReader jsonReader)

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.

getAiServices

public AiServices getAiServices()

Get the aiServices property: Optional AI Services configuration for content processing.

Returns:

the aiServices value.

getChatCompletionModel

public KnowledgeBaseModel getChatCompletionModel()

Get the chatCompletionModel property: Optional chat completion model for image verbalization or context extraction.

Returns:

the chatCompletionModel value.

getContentExtractionMode

public KnowledgeSourceContentExtractionMode getContentExtractionMode()

Get the contentExtractionMode property: Optional content extraction mode. Default is 'minimal'.

Returns:

the contentExtractionMode value.

getEmbeddingModel

public KnowledgeSourceVectorizer getEmbeddingModel()

Get the embeddingModel property: Optional vectorizer configuration for vectorizing content.

Returns:

the embeddingModel value.

getIdentity

public SearchIndexerDataIdentity getIdentity()

Get the identity property: An explicit identity to use for this knowledge source.

Returns:

the identity value.

getIngestionSchedule

public IndexingSchedule getIngestionSchedule()

Get the ingestionSchedule property: Optional schedule for data ingestion.

Returns:

the ingestionSchedule value.

isDisableImageVerbalization

public Boolean isDisableImageVerbalization()

Get the disableImageVerbalization property: Indicates whether image verbalization should be disabled. Default is false.

Returns:

the disableImageVerbalization 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.

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.

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.

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.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to