Skip to main content

GenaiCreateKnowledgeBaseDataSourceBody

Struct GenaiCreateKnowledgeBaseDataSourceBody 

Source
pub struct GenaiCreateKnowledgeBaseDataSourceBody {
    pub aws_data_source: Option<GenaiCreateKnowledgeBaseDataSourceBodyAwsDataSource>,
    pub chunking_algorithm: GenaiCreateKnowledgeBaseDataSourceBodyChunkingAlgorithm,
    pub chunking_options: Option<GenaiCreateKnowledgeBaseDataSourceBodyChunkingOptions>,
    pub knowledge_base_uuid: Option<String>,
    pub spaces_data_source: Option<GenaiCreateKnowledgeBaseDataSourceBodySpacesDataSource>,
    pub web_crawler_data_source: Option<GenaiCreateKnowledgeBaseDataSourceBodyWebCrawlerDataSource>,
}
Expand description

Data to create a knowledge base data source

JSON schema
{
 "description": "Data to create a knowledge base data source",
 "type": "object",
 "properties": {
   "aws_data_source": {
     "description": "AWS S3 Data Source",
     "type": "object",
     "properties": {
       "bucket_name": {
         "description": "Spaces bucket name",
         "examples": [
           "example name"
         ],
         "type": "string"
       },
       "item_path": {
         "examples": [
           "example string"
         ],
         "type": "string"
       },
       "key_id": {
         "description": "The AWS Key ID",
         "examples": [
           "123e4567-e89b-12d3-a456-426614174000"
         ],
         "type": "string"
       },
       "region": {
         "description": "Region of bucket",
         "examples": [
           "example string"
         ],
         "type": "string"
       },
       "secret_key": {
         "description": "The AWS Secret Key",
         "examples": [
           "example string"
         ],
         "type": "string"
       }
     }
   },
   "chunking_algorithm": {
     "default": "CHUNKING_ALGORITHM_UNKNOWN",
     "examples": [
       "CHUNKING_ALGORITHM_UNKNOWN"
     ],
     "type": "string",
     "enum": [
       "CHUNKING_ALGORITHM_UNKNOWN",
       "CHUNKING_ALGORITHM_SECTION_BASED",
       "CHUNKING_ALGORITHM_HIERARCHICAL",
       "CHUNKING_ALGORITHM_SEMANTIC",
       "CHUNKING_ALGORITHM_FIXED_LENGTH"
     ]
   },
   "chunking_options": {
     "type": "object",
     "properties": {
       "child_chunk_size": {
         "examples": [
           350
         ],
         "type": "integer",
         "format": "int64"
       },
       "max_chunk_size": {
         "description": "Common options",
         "examples": [
           750
         ],
         "type": "integer",
         "format": "int64"
       },
       "parent_chunk_size": {
         "description": "Hierarchical options",
         "examples": [
           1000
         ],
         "type": "integer",
         "format": "int64"
       },
       "semantic_threshold": {
         "description": "Semantic options",
         "examples": [
           0.5
         ],
         "type": "number",
         "format": "float"
       }
     }
   },
   "knowledge_base_uuid": {
     "description": "Knowledge base id",
     "examples": [
       "\"12345678-1234-1234-1234-123456789012\""
     ],
     "type": "string"
   },
   "spaces_data_source": {
     "description": "Spaces Bucket Data Source",
     "type": "object",
     "properties": {
       "bucket_name": {
         "description": "Spaces bucket name",
         "examples": [
           "example name"
         ],
         "type": "string"
       },
       "item_path": {
         "examples": [
           "example string"
         ],
         "type": "string"
       },
       "region": {
         "description": "Region of bucket",
         "examples": [
           "example string"
         ],
         "type": "string"
       }
     }
   },
   "web_crawler_data_source": {
     "description": "WebCrawlerDataSource",
     "type": "object",
     "properties": {
       "base_url": {
         "description": "The base url to crawl.",
         "examples": [
           "example string"
         ],
         "type": "string"
       },
       "crawling_option": {
         "description": "Auto-generated fallback definition for: apiCrawlingOption",
         "type": "object",
         "additionalProperties": true
       },
       "embed_media": {
         "description": "Whether to ingest and index media (images, etc.) on web pages.",
         "examples": [
           true
         ],
         "type": "boolean"
       },
       "exclude_tags": {
         "description": "Declaring which tags to exclude in web pages while webcrawling",
         "examples": [
           [
             "example string"
           ]
         ],
         "type": "array",
         "items": {
           "examples": [
             "example string"
           ],
           "type": "string"
         }
       }
     }
   }
 }
}

Fields§

§aws_data_source: Option<GenaiCreateKnowledgeBaseDataSourceBodyAwsDataSource>§chunking_algorithm: GenaiCreateKnowledgeBaseDataSourceBodyChunkingAlgorithm§chunking_options: Option<GenaiCreateKnowledgeBaseDataSourceBodyChunkingOptions>§knowledge_base_uuid: Option<String>

Knowledge base id

§spaces_data_source: Option<GenaiCreateKnowledgeBaseDataSourceBodySpacesDataSource>§web_crawler_data_source: Option<GenaiCreateKnowledgeBaseDataSourceBodyWebCrawlerDataSource>

Trait Implementations§

Source§

impl Clone for GenaiCreateKnowledgeBaseDataSourceBody

Source§

fn clone(&self) -> GenaiCreateKnowledgeBaseDataSourceBody

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GenaiCreateKnowledgeBaseDataSourceBody

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for GenaiCreateKnowledgeBaseDataSourceBody

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GenaiCreateKnowledgeBaseDataSourceBody

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&GenaiCreateKnowledgeBaseDataSourceBody> for GenaiCreateKnowledgeBaseDataSourceBody

Source§

fn from(value: &GenaiCreateKnowledgeBaseDataSourceBody) -> Self

Converts to this type from the input type.
Source§

impl Serialize for GenaiCreateKnowledgeBaseDataSourceBody

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more