Corpora

Yöntem: corpora.create

Boş bir Corpus oluşturur.

Uç nokta

yayın https://generativelanguage.googleapis.com/v1beta/corpora

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili belgeler"

Yanıt gövdesi

Başarılı olursa yanıt metni, yeni oluşturulmuş bir Corpus örneği içerir.

Yöntem: corpora.query

Corpus üzerinde semantik arama yapar.

Uç nokta

yayın https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Yol parametreleri

name string

Zorunlu. Sorgulanacak Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
query string

Zorunlu. Semantik arama yapmak için kullanılan sorgu dizesi.

metadataFilters[] object (MetadataFilter)

İsteğe bağlı. Chunk ve Document meta verilerine göre filtreleme yapın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesnesi mantıksal "AND"larla birleştirilir.

Belge düzeyinde örnek sorgu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter nesne listesi: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Sayısal bir değer aralığı için parça düzeyinde örnek sorgu: (year > 2015 AND year <= 2020)

MetadataFilter nesne listesi: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Not: Aynı anahtar için "VE" operatörleri yalnızca sayısal değerlerde desteklenir. Dize değerleri, yalnızca aynı anahtar için "VEYA"ları destekler.

resultsCount integer

İsteğe bağlı. Döndürülecek maksimum Chunk sayısı. Hizmet daha az Chunk döndürebilir.

Belirtilmemişse en fazla 10 Chunk döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.

Yanıt gövdesi

Alakalı parçaların listesini içeren corpora.query yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
relevantChunks[] object (RelevantChunk)

Alakalı parçalar.

JSON gösterimi 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Yöntem: corpora.list

Kullanıcıya ait tüm Corpora öğelerini listeler.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/corpora

Sorgu parametreleri

pageSize integer

İsteğe bağlı. Döndürülecek maksimum Corpora sayısı (sayfa başına). Hizmet daha az Corpora döndürebilir.

Belirtilmemişse en fazla 10 Corpora döndürülür. Maksimum boyut sınırı sayfa başına 20 Corpora'tır.

pageToken string

İsteğe bağlı. Önceki bir corpora.list çağrısından alınan sayfa jetonu.

Sonraki sayfayı almak için yanıtta döndürülen nextPageToken değerini bir sonraki isteğinin bağımsız değişkeni olarak sağlayın.

Sayfalandırma yapılırken corpora.list parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

corpora.list tarafından gönderilen ve sayfalandırılmış bir Corpora listesi içeren yanıt. Sonuçlar artan corpus.create_time değerine göre sıralanır.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
corpora[] object (Corpus)

Döndürülen derlemeler.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa başka sayfa yoktur.

JSON gösterimi 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Yöntem: corpora.get

Belirli bir Corpus hakkında bilgi alır.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.patch

Corpus güncellemesi

Uç nokta

yama https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Yol parametreleri

corpus.name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c corpora/{corpora} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda yalnızca displayName güncellemesi desteklenmektedir.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili dokümanlar"

Yanıt gövdesi

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.delete

Bir Corpus'yi siler.

Uç nokta

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus kaynağının adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

Sorgu parametreleri

force boolean

İsteğe bağlı. Doğru olarak ayarlanırsa bu Corpus ile ilişkili tüm Document'ler ve nesneler de silinir.

Yanlış ise (varsayılan) Corpus herhangi bir Document içeriyorsa FAILED_PRECONDITION hatası döndürülür.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni boş bir JSON nesnesi olur.

REST Kaynağı: corpora.permissions

Kaynak: İzin

İzin kaynağı, kullanıcıya, gruba veya dünyanın geri kalanına PaLM API kaynağına (ör. hassaslaştırılmış model, korpus) erişim izni verir.

Rol, kullanıcıların PaLM API kaynaklarında belirli işlemleri gerçekleştirmesine olanak tanıyan izin verilen işlemlerden oluşan bir koleksiyondur. Bu kaynakları kullanıcıların, grupların veya hizmet hesaplarının kullanımına sunmak için roller atarsınız. Bir rol atadığınızda, rolün içerdiği izinleri vermiş olursunuz.

Üç eş merkezli rol vardır. Her rol, önceki rolün izin verilen işlemlerinin bir üst kümesidir:

  • Okuyucu, çıkarım için kaynağı (ör. ayarlanmış model, kitaplık) kullanabilir
  • Yazar, okuyucunun izinlerine sahiptir ve ayrıca düzenleyebilir ve paylaşabilir.
  • sahibi, yazar izinlerine sahiptir ve ayrıca silebilir
Alanlar
name string

Yalnızca çıkış. Tanımlayıcı. İzin adı. Oluşturma sırasında benzersiz bir ad oluşturulur. Örnekler: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Yalnızca çıkış.

granteeType enum (GranteeType)

İsteğe bağlı. Değişmez. Hak sahibinin türü.

emailAddress string

İsteğe bağlı. Değişmez. Bu iznin ait olduğu kullanıcı veya grubun e-posta adresi. İznin veriliş türü HERKES olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

JSON gösterimi 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Bu iznin verileni türlerini tanımlar.

Sıralamalar
GRANTEE_TYPE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
USER Bir kullanıcıyı temsil eder. Ayarlandığında, kullanıcı için emailAddress değerini sağlamanız gerekir.
GROUP Bir grubu temsil eder. Ayarlandığında grup için emailAddress değerini sağlamanız gerekir.
EVERYONE Herkesin erişimini temsil eder. Ek bilgi gerekmez.

Rol

Bu izinle verilen rolü tanımlar.

Sıralamalar
ROLE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
OWNER Sahip, kaynağı kullanabilir, güncelleyebilir, paylaşabilir ve silebilir.
WRITER Yazar, kaynağı kullanabilir, güncelleyebilir ve paylaşabilir.
READER Okuyucu kaynağı kullanabilir.

MetadataFilter

Chunk veya Document düzeyindeki meta veri değerlerine göre getirmeyi sınırlamak için kullanıcı tarafından sağlanan filtre. Örnek (tür = dram VEYA tür = aksiyon): anahtar = "document.custom_metadata.genre" koşullar = [{stringValue = "drama", operation = EŞİT}, {stringValue = "action", operation = EŞİT}]

Alanlar
key string

Zorunlu. Filtrelemek için kullanılacak meta verinin anahtarı.

conditions[] object (Condition)

Zorunlu. Belirtilen anahtar için bu filtreyi tetikleyecek Condition değerleri. Birden fazla Condition, mantıksal VEYA'larla birleştirilir.

JSON gösterimi 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Koşul

Tek bir anahtar için geçerli filtre koşulu.

Alanlar
operation enum (Operator)

Zorunlu. Koşulu tetiklemek için belirli bir anahtar/değer çiftine uygulanan operatör.

value Union type
Değer türü, ilgili anahtar için alanda tanımlanan değer türüyle tutarlı olmalıdır. Değer türleri tutarlı değilse sonuç boş bir küme olur. CustomMetadata, StringList değer türüne sahip olduğunda filtreleme koşulu, INCLUDES/EXCLUDES işlemiyle birlikte string_value kullanmalıdır. Aksi takdirde sonuç da boş bir küme olur. value yalnızca aşağıdakilerden biri olabilir:
stringValue string

Meta verileri filtrelemek için kullanılacak dize değeri.

numericValue number

Meta verileri filtrelemek için kullanılacak sayısal değer.

JSON gösterimi 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operatör

Bir anahtar/değer çiftine uygulanabilecek geçerli operatörleri tanımlar.

Sıralamalar
OPERATOR_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
LESS Sayısal değerler desteklenir.
LESS_EQUAL Sayısal değerler desteklenir.
EQUAL Sayı ve dize desteklenir.
GREATER_EQUAL Sayısal değerler desteklenir.
GREATER Sayısal değerler desteklenir.
NOT_EQUAL Sayı ve dize desteklenir.
INCLUDES Yalnızca belirli bir anahtar için CustomMetadata değer türü stringListValue içerdiğinde dize olarak desteklenir.
EXCLUDES Yalnızca belirli bir anahtar için CustomMetadata değer türü stringListValue içerdiğinde dize olarak desteklenir.

RelevantChunk

Bir sorguyla alakalı bir parçanın bilgileri.

Alanlar
chunkRelevanceScore number

Chunk sorguyla alaka düzeyi.

chunk object (Chunk)

Chunk ile ilişkilendirilir.

JSON gösterimi 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

REST Kaynağı: corpora

Kaynak: Corpus

Corpus, Document'lerden oluşan bir koleksiyondur. Bir projede en fazla 5 korpus oluşturulabilir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili dokümanlar"

createTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin oluşturulduğu zaman damgası.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin en son güncellendiği zaman damgası.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}