Class: OpenAI::Models::VectorStoreCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::VectorStoreCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/vector_store_create_params.rb

Overview

See Also:

• Resources::VectorStores#create

Defined Under Namespace

Classes: ExpiresAfter

Instance Attribute Summary

• #chunking_strategy ⇒ OpenAI::Models::AutoFileChunkingStrategyParam, ...

  The chunking strategy used to chunk the file(s).

• #expires_after ⇒ OpenAI::Models::VectorStoreCreateParams::ExpiresAfter^?

  The expiration policy for a vector store.

• #file_ids ⇒ Array<String>^?

  A list of [File](platform.openai.com/docs/api-reference/files) IDs that the vector store should use.

• #metadata ⇒ Hash{Symbol=>String}^?

  Set of 16 key-value pairs that can be attached to an object.

• #name ⇒ String^?

  The name of the vector store.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#chunking_strategy ⇒ OpenAI::Models::AutoFileChunkingStrategyParam, ...

The chunking strategy used to chunk the file(s). If not set, will use the ‘auto` strategy. Only applicable if `file_ids` is non-empty.

Returns:

• (OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam, nil)

# File 'lib/openai/models/vector_store_create_params.rb', line 15

optional :chunking_strategy, union: -> { OpenAI::FileChunkingStrategyParam }

#expires_after ⇒ OpenAI::Models::VectorStoreCreateParams::ExpiresAfter^?

The expiration policy for a vector store.

Returns:

• (OpenAI::Models::VectorStoreCreateParams::ExpiresAfter, nil)

# File 'lib/openai/models/vector_store_create_params.rb', line 21

optional :expires_after, -> { OpenAI::VectorStoreCreateParams::ExpiresAfter }

#file_ids ⇒ Array<String>^?

A list of [File](platform.openai.com/docs/api-reference/files) IDs that the vector store should use. Useful for tools like ‘file_search` that can access files.

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/vector_store_create_params.rb', line 29

optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]

#metadata ⇒ Hash{Symbol=>String}^?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/openai/models/vector_store_create_params.rb', line 40

optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#name ⇒ String^?

The name of the vector store.

Returns:

• (String, nil)

# File 'lib/openai/models/vector_store_create_params.rb', line 46

optional :name, String